Skip to content

Commit 30ee00e

Browse files
committed
updated readme
1 parent 9728535 commit 30ee00e

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,19 +51,24 @@ Before running the training script, ensure the results directory exists:
5151
### 2) Run the following command for training, evaluation and testing
5252

5353
`python3 main.py --modelname "<MODEL_NAME>" --dataset "<DATASET_NAME>" --metric "<METRIC_1>" "<METRIC_2>" ... "<METRIC_N>" --resultfolder "<RESULTS_DIRECTORY>" --run_name "<RUN_NAME>" --device "<DEVICE>"`
54-
Replace placeholders with your desired values:
54+
<br> Replace placeholders with your desired values:
5555

56-
`<MODEL_NAME>`: You can choose from different models ( `"MagnusModel", "ChristianModel", "SolveigModel", "JanModel", "JohanModel"`).
56+
- `<MODEL_NAME>`: You can choose from different models ( `"MagnusModel", "ChristianModel", "SolveigModel", "JanModel", "JohanModel"`).
5757

58-
`<DATASET_NAME>`: The following datasets are supported (`"svhn", "usps_0-6", "usps_7-9", "mnist_0-3", "mnist_4-9"`)
5958

60-
`<METRIC_1> ... <METRIC_N>`: Specify one or more evaluation metrics (`"entropy", "f1", "recall", "precision", "accuracy"`)
59+
- `<DATASET_NAME>`: The following datasets are supported (`"svhn", "usps_0-6", "usps_7-9", "mnist_0-3", "mnist_4-9"`)
6160

62-
`<RESULTS_DIRECTORY>`: Folder where all model outputs, logs, and checkpoints are saved
6361

64-
`<RUN_NAME>`: Name for WANDB project
62+
- `<METRIC_1> ... <METRIC_N>`: Specify one or more evaluation metrics (`"entropy", "f1", "recall", "precision", "accuracy"`)
6563

66-
`<DEVICE>`: `"cuda", "cpu", "mps"`
64+
65+
- `<RESULTS_DIRECTORY>`: Folder where all model outputs, logs, and checkpoints are saved
66+
67+
68+
- `<RUN_NAME>`: Name for WANDB project
69+
70+
71+
- `<DEVICE>`: `"cuda", "cpu", "mps"`
6772

6873

6974
## Running on a k8s cluster

0 commit comments

Comments
 (0)