From 0bfc567a7148d7aa80ce9c5de1c30bd5cfe947b4 Mon Sep 17 00:00:00 2001 From: Solveig Date: Wed, 26 Feb 2025 17:15:15 +0100 Subject: [PATCH 1/9] started to update readme --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index f0b7b3f..ac1477f 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,16 @@ # Collaborative-Coding-Exam Repository for final evaluation in the FYS-8805 Reproducible Research and Collaborative coding course +## **Table of Contents** +1. [Project Description](#project-description) +2. [Installation](#installation) +3. [Usage](#usage) +4. [Results](#results) +5. [Citing](#citing) + +## Project Description + + ## Installation Install from: @@ -46,3 +56,17 @@ to pull the latest build, or check the [packages](https://github.com/SFI-Visual- > [!NOTE] > The container is build for a `linux/amd64` architecture to properly build Cuda 12. For other architectures please build the docker image locally. + + +## Results + +| Model | Accuracy | Entropy | F1 Score | Precision | Recall | +|-----------|----------|---------|----------|-----------|--------| +| Christian | | | | | | +| Jan | | | | | | +| Johan | | | | | | +| Magnus | | | | | | +| Solveig | | | | | | + + +## Citing From 823bab677afc272edbc71472a94fb8bf4921efde Mon Sep 17 00:00:00 2001 From: Solveig Date: Thu, 27 Feb 2025 10:51:32 +0100 Subject: [PATCH 2/9] updated readme --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ac1477f..638569e 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,13 @@ Repository for final evaluation in the FYS-8805 Reproducible Research and Collab 5. [Citing](#citing) ## Project Description - +This project involves collaborative work on a digit classification task, where each participant works on distinct but interconnected components within a shared codebase.
+The main goal is to develop and train digit classification models collaboratively, with a focus on leveraging shared resources and learning efficient experimentation practices. +### Key Aspects of the Project: +- **Individual and Joint Tasks:** Each participant has separate tasks, such as implementing a digit classification dataset, a neural network model, and an evaluation metric. However, all models and datasets must be compatible, as we can only train and evaluate using partners' models and datasets. +- **Shared Environment:** Alongside working on our individual tasks, we collaborate on joint tasks like the main file, and training and evaluation loops. Additionally, we utilize a shared Weights and Biases environment for experiment management. +- **Documentation and Package Management:** To ensure proper documentation and ease of use, we set up Sphinx documentation and made the repository pip-installable +- **High-Performance Computing:** A key learning objective of this project is to gain experience with running experiments on high-performance computing (HPC) resources. To this end, we trained all models on a cluster ## Installation From 878f5546df559c9cf564ccb57d7cc52abf5ff543 Mon Sep 17 00:00:00 2001 From: Christian Salomonsen <55956280+salomaestro@users.noreply.github.com> Date: Thu, 27 Feb 2025 11:10:41 +0100 Subject: [PATCH 3/9] Add dataset column I think it makes sense to have one, @sot176 do you agree? --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 638569e..ce922d7 100644 --- a/README.md +++ b/README.md @@ -66,13 +66,13 @@ to pull the latest build, or check the [packages](https://github.com/SFI-Visual- ## Results -| Model | Accuracy | Entropy | F1 Score | Precision | Recall | -|-----------|----------|---------|----------|-----------|--------| -| Christian | | | | | | -| Jan | | | | | | -| Johan | | | | | | -| Magnus | | | | | | -| Solveig | | | | | | +| Model | Dataset | Accuracy | Entropy | F1 Score | Precision | Recall | +|-----------|---------|----------|---------|----------|-----------|--------| +| Christian | | | | | | | +| Jan | | | | | | | +| Johan | | | | | | | +| Magnus | | | | | | | +| Solveig | | | | | | | ## Citing From 92407f5a33d18d0cdd4a0b4bec5ee858e369ce96 Mon Sep 17 00:00:00 2001 From: Solveig Thrun <144994301+sot176@users.noreply.github.com> Date: Thu, 27 Feb 2025 12:27:02 +0100 Subject: [PATCH 4/9] Update README.md --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ce922d7..4b1278a 100644 --- a/README.md +++ b/README.md @@ -66,13 +66,13 @@ to pull the latest build, or check the [packages](https://github.com/SFI-Visual- ## Results -| Model | Dataset | Accuracy | Entropy | F1 Score | Precision | Recall | -|-----------|---------|----------|---------|----------|-----------|--------| -| Christian | | | | | | | -| Jan | | | | | | | -| Johan | | | | | | | -| Magnus | | | | | | | -| Solveig | | | | | | | +| Model | Dataset | Accuracy | Entropy | F1 Score | Precision | Recall | +|-----------|-----------|----------|---------|----------|-----------|--------| +| Christian |USPS (0-6) | | | | | | +| Jan |MNIST(0-3) | | | | | | +| Johan |MNITS (4-9)| | | | | | +| Magnus |SVHN | | | | | | +| Solveig |USPS (7-9) | | | | | | ## Citing From 6b00fbf66dc7c916ec9eb18e2096604cafdb1eea Mon Sep 17 00:00:00 2001 From: Solveig Date: Sat, 1 Mar 2025 10:56:58 +0100 Subject: [PATCH 5/9] added usage section --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4b1278a..d267d77 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,30 @@ python -c "import CollaborativeCoding" ## Usage -TODO: Fill in +To train a classification model using this code, follow these steps: + +### 1) Create a Directory for the reuslts +Before running the training script, ensure the results directory exists: + + `mkdir -p ""` + +### 2) Run the following command for training, evaluation and testing + + `python3 main.py --modelname "" --dataset "" --metric "" "" ... "" --resultfolder "" --run_name "" --device "" -` +Replace placeholders with your desired values: + +``: You can choose from different models ( `"MagnusModel", "ChristianModel", "SolveigModel", "JanModel", "JohanModel"`). + +``: The following datasets are supported (`"svhn", "usps_0-6", "usps_7-9", "mnist_0-3", "mnist_4-9"`) + +` ... `: Specify one or more evaluation metrics (`"entropy", "f1", "recall", "precision", "accuracy"`) + +``: Folder where all model outputs, logs, and checkpoints are saved + +``: Name for WANDB project + +``: `"cuda", "cpu", "mps"` + ### Running on a k8s cluster From ac69197bfeff407619c385dc77906878a715ec85 Mon Sep 17 00:00:00 2001 From: Solveig Date: Sat, 1 Mar 2025 11:05:37 +0100 Subject: [PATCH 6/9] added citation --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index d267d77..177f8a6 100644 --- a/README.md +++ b/README.md @@ -99,3 +99,16 @@ to pull the latest build, or check the [packages](https://github.com/SFI-Visual- ## Citing +If you use this project in your research or work, please cite it as follows: + +### **BibTeX Citation** + +```bibtex +@software{Collaborative_Coding_Exam_2025, +author = {Thrun, Solveig and Salomonsen, Christian and Størdal, Magnus and Zavadil, Jan and Mylius-Kroken, Johan}, +month = feb, +title = {{Collaborative Coding Exam}}, +url = {https://github.com/SFI-Visual-Intelligence/Collaborative-Coding-Exam}, +version = {1.1.0}, +year = {2025} +} \ No newline at end of file From 9adba21c7eb2f9b9fca5a72568b9e781452dd0ba Mon Sep 17 00:00:00 2001 From: Solveig Thrun <144994301+sot176@users.noreply.github.com> Date: Sat, 1 Mar 2025 11:06:21 +0100 Subject: [PATCH 7/9] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 177f8a6..8f2fd60 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ Before running the training script, ensure the results directory exists: ### 2) Run the following command for training, evaluation and testing - `python3 main.py --modelname "" --dataset "" --metric "" "" ... "" --resultfolder "" --run_name "" --device "" -` + `python3 main.py --modelname "" --dataset "" --metric "" "" ... "" --resultfolder "" --run_name "" --device ""` Replace placeholders with your desired values: ``: You can choose from different models ( `"MagnusModel", "ChristianModel", "SolveigModel", "JanModel", "JohanModel"`). @@ -111,4 +111,4 @@ title = {{Collaborative Coding Exam}}, url = {https://github.com/SFI-Visual-Intelligence/Collaborative-Coding-Exam}, version = {1.1.0}, year = {2025} -} \ No newline at end of file +} From 9728535a8d0f707d4de2a76a23b410388a9835ff Mon Sep 17 00:00:00 2001 From: Solveig Thrun <144994301+sot176@users.noreply.github.com> Date: Sat, 1 Mar 2025 11:06:55 +0100 Subject: [PATCH 8/9] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8f2fd60..a1ceb4a 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,7 @@ Replace placeholders with your desired values: ``: `"cuda", "cpu", "mps"` -### Running on a k8s cluster +## Running on a k8s cluster In your job manifest, include: From 30ee00e5889c7c5c834778b9285db248bb518b60 Mon Sep 17 00:00:00 2001 From: Solveig Date: Sat, 1 Mar 2025 11:15:19 +0100 Subject: [PATCH 9/9] updated readme --- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index a1ceb4a..a58a2cd 100644 --- a/README.md +++ b/README.md @@ -51,19 +51,24 @@ Before running the training script, ensure the results directory exists: ### 2) Run the following command for training, evaluation and testing `python3 main.py --modelname "" --dataset "" --metric "" "" ... "" --resultfolder "" --run_name "" --device ""` -Replace placeholders with your desired values: +
Replace placeholders with your desired values: -``: You can choose from different models ( `"MagnusModel", "ChristianModel", "SolveigModel", "JanModel", "JohanModel"`). +- ``: You can choose from different models ( `"MagnusModel", "ChristianModel", "SolveigModel", "JanModel", "JohanModel"`). -``: The following datasets are supported (`"svhn", "usps_0-6", "usps_7-9", "mnist_0-3", "mnist_4-9"`) -` ... `: Specify one or more evaluation metrics (`"entropy", "f1", "recall", "precision", "accuracy"`) +- ``: The following datasets are supported (`"svhn", "usps_0-6", "usps_7-9", "mnist_0-3", "mnist_4-9"`) -``: Folder where all model outputs, logs, and checkpoints are saved -``: Name for WANDB project +- ` ... `: Specify one or more evaluation metrics (`"entropy", "f1", "recall", "precision", "accuracy"`) -``: `"cuda", "cpu", "mps"` + +- ``: Folder where all model outputs, logs, and checkpoints are saved + + +- ``: Name for WANDB project + + +- ``: `"cuda", "cpu", "mps"` ## Running on a k8s cluster