Skip to content

Commit a3715a5

Browse files
committed
Fixed erroors in my documentation
1 parent 3ad724f commit a3715a5

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

doc/Solveig.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
Solveig Individual Task
2-
======================
1+
# Solveig Individual Task
32

4-
# Task overview
3+
## Task overview
54
In addition to the overall task, I was assigned the implementation of the following tasks:
65
* A [CNN-model](../CollaborativeCoding/models/solveig_model.py)
76
* A dataset class for the [USPS dataset](../CollaborativeCoding/dataloaders/uspsh5_7_9.py) for the digits from 7-9
@@ -97,7 +96,7 @@ The class is initalized with two parameters:
9796

9897

9998

100-
# Experiences running another person's code
99+
## Experiences running another person's code
101100
At the beginning of our project, we adopted a common code structure that would accommodate various wrappers managing the initialization and data flow of metrics, dataloaders, and models.
102101
To ensure smooth collaboration, we leveraged GitHub Actions for automated testing, which helped us validate the functionality of our dataloaders, metrics, and models.
103102
Once the various classes passed their tests, running code from other team members was no problem.
@@ -109,7 +108,7 @@ This approach made it much easier to understand the changes.
109108

110109

111110

112-
# Experiences another person running my code
111+
## Experiences another person running my code
113112
During the process of another person running my code, I got informed about an issue with my F1 metric, where it failed to handle an unexpected edge case at runtime—something that the initial tests did not catch.
114113
Once the issue was raised, I was promptly informed, and I addressed the error.
115114
However, as mentioned earlier, there were times when large pull requests included multiple important changes, making it challenging to adjust my code accordingly.
@@ -118,7 +117,7 @@ Despite this, the collaborative nature of the process allowed us to identify and
118117

119118

120119

121-
# Tools
120+
## Tools
122121
During the collaborative coding course, I had the opportunity to learn and work with several valuable tools that were new to me:
123122
* **Docker**
124123
* **Ruff and Isort**

0 commit comments

Comments
 (0)