Anirudh Balaraman commited on
Commit
9cc4997
Β·
unverified Β·
1 Parent(s): c0334de

Enhance README with usage and output information

Browse files

Updated usage instructions and output details in README.md.

Files changed (1) hide show
  1. README.md +15 -5
README.md CHANGED
@@ -53,15 +53,25 @@ curl -L -o models/file3.pth https://huggingface.co/anirudh0410/WSAttention-Prost
53
 
54
  ## πŸš€ Usage
55
  ### Inference
 
 
 
56
 
57
- Run run_inference.py to execute the full pipeline, from preprocessing to model predictions. The script accepts paths to T2W, DWI, and ADC sequences, as well as an output directory(output_dir), which can be specified in config_preprocess.yaml. ***NOTE:*** For each scan, all sequences should share the same filename, and the input files must be in NRRD format.
 
 
 
 
 
 
 
 
 
 
 
58
 
59
- Outputs are risk of csPCa, PI-RADS score and coordinaates of top 5 salient patches for each scan summarised in results.json saved in output_dir along with the intermediary files from pre processing including the prostate segmentation mask. The patches can be visualised using visualisation.ipynb
60
 
61
 
62
- ```bash
63
- python run_inference.py --config config/config_preprocess.yaml
64
- ```
65
 
66
  ### Preprocessing
67
 
 
53
 
54
  ## πŸš€ Usage
55
  ### Inference
56
+ ```bash
57
+ python run_inference.py --config config/config_preprocess.yaml
58
+ ```
59
 
60
+ Run run_inference.py to execute the full pipeline, from preprocessing to model predictions.
61
+ - πŸ“ Inputs:
62
+ - πŸ“‚ *t2_dir, dwi_dir, adc_dir*: Path to T2W, DWI and ADC sequnces respectively.
63
+ - πŸ“‚ *output_dir*: Path to store preprocessed files and results.
64
+ ⚠️ ***NOTE: For each scan, all sequences should share the same filename, and the input files must be in NRRD format.***
65
+
66
+ - πŸ“Š Outputs:
67
+ The following are stored for each scan:
68
+ - 🩺 Risk of csPCa.
69
+ - πŸ”’ PI-RADS score.
70
+ - πŸ“ Coordinaates of top 5 salient patches.
71
+ The results are stored in results.json saved in output_dir along with the intermediary files from pre processing including the prostate segmentation mask. The patches can be visualised using visualisation.ipynb
72
 
 
73
 
74
 
 
 
 
75
 
76
  ### Preprocessing
77