Anirudh Balaraman commited on
Commit
6727502
Β·
unverified Β·
1 Parent(s): f6b233e

Update configuration.md

Browse files
Files changed (1) hide show
  1. docs/configuration.md +3 -7
docs/configuration.md CHANGED
@@ -12,8 +12,8 @@ python run_pirads.py --mode train --config config/config_pirads_train.yaml
12
  |-----------|---------|-------------|
13
  | `mode` | β€” | `train` or `test` (required) |
14
  | `config` | β€” | Path to YAML config file |
15
- | `data_root` | β€” | Root folder of images |
16
- | `dataset_json` | β€” | Path to dataset JSON file |
17
  | `num_classes` | `4` | Number of output classes (PI-RADS 2–5) |
18
  | `mil_mode` | `att_trans` | MIL algorithm (`mean`, `max`, `att`, `att_trans`, `att_trans_pyramid`) |
19
  | `tile_count` | `24` | Number of patches per scan |
@@ -31,8 +31,7 @@ python run_pirads.py --mode train --config config/config_pirads_train.yaml
31
  | `val_every` | `1` | Validation frequency (epochs) |
32
  | `wandb` | `False` | Enable Weights & Biases logging |
33
  | `project_name` | `Classification_prostate` | W&B project name |
34
- | `run_name` | `train_pirads` | Run name for logging |
35
- | `dry_run` | `False` | Quick test mode (2 epochs, batch_size=2, no W&B) |
36
 
37
  ## csPCa Training Parameters
38
 
@@ -48,7 +47,6 @@ python run_pirads.py --mode train --config config/config_pirads_train.yaml
48
  | `batch_size` | `32` | Scans per batch |
49
  | `optim_lr` | `2e-4` | Learning rate |
50
  | `num_seeds` | `20` | Number of random seeds for CI |
51
- | `dry_run` | `False` | Quick test mode |
52
 
53
  Shared parameters (`num_classes`, `mil_mode`, `tile_count`, `tile_size`, `depth`, `use_heatmap`, `workers`, `val_every`) have the same defaults as PI-RADS.
54
 
@@ -64,7 +62,6 @@ Shared parameters (`num_classes`, `mil_mode`, `tile_count`, `tile_size`, `depth`
64
  | `seg_dir` | β€” | Directory of segmentation masks |
65
  | `output_dir` | β€” | Output directory |
66
  | `margin` | `0.2` | Center-crop margin fraction |
67
- | `project_dir` | β€” | Project root (for reference images and models) |
68
 
69
  ## Example YAML
70
 
@@ -113,5 +110,4 @@ Shared parameters (`num_classes`, `mil_mode`, `tile_count`, `tile_size`, `depth`
113
  dwi_dir: /path/to/raw/dwi
114
  adc_dir: /path/to/raw/adc
115
  output_dir: /path/to/processed
116
- project_dir: /path/to/WSAttention-Prostate
117
  ```
 
12
  |-----------|---------|-------------|
13
  | `mode` | β€” | `train` or `test` (required) |
14
  | `config` | β€” | Path to YAML config file |
15
+ | `data_root` | β€” | Root folder of T2W images |
16
+ | `dataset_json` | β€” | Path to dataset JSON file. Format should be as specified in [Getting Started](getting-started.md) |
17
  | `num_classes` | `4` | Number of output classes (PI-RADS 2–5) |
18
  | `mil_mode` | `att_trans` | MIL algorithm (`mean`, `max`, `att`, `att_trans`, `att_trans_pyramid`) |
19
  | `tile_count` | `24` | Number of patches per scan |
 
31
  | `val_every` | `1` | Validation frequency (epochs) |
32
  | `wandb` | `False` | Enable Weights & Biases logging |
33
  | `project_name` | `Classification_prostate` | W&B project name |
34
+ | `run_name` | `train_pirads` | Run name for logging. If using SLURM, takes SLURM JOB_ID |
 
35
 
36
  ## csPCa Training Parameters
37
 
 
47
  | `batch_size` | `32` | Scans per batch |
48
  | `optim_lr` | `2e-4` | Learning rate |
49
  | `num_seeds` | `20` | Number of random seeds for CI |
 
50
 
51
  Shared parameters (`num_classes`, `mil_mode`, `tile_count`, `tile_size`, `depth`, `use_heatmap`, `workers`, `val_every`) have the same defaults as PI-RADS.
52
 
 
62
  | `seg_dir` | β€” | Directory of segmentation masks |
63
  | `output_dir` | β€” | Output directory |
64
  | `margin` | `0.2` | Center-crop margin fraction |
 
65
 
66
  ## Example YAML
67
 
 
110
  dwi_dir: /path/to/raw/dwi
111
  adc_dir: /path/to/raw/adc
112
  output_dir: /path/to/processed
 
113
  ```