Skip to content

Commit

Permalink
Add info on how to download compute_metrics_reloaded.py
Browse files Browse the repository at this point in the history
  • Loading branch information
valosekj authored Jun 1, 2024
1 parent 2019d24 commit ffb631d
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions quick_start_guides/MetricsReloaded_quick_start_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,18 @@ python -m pip install -e .

## Usage

You can use the [compute_metrics_reloaded.py](../compute_metrics/compute_metrics_reloaded.py) script to compute metrics using the MetricsReloaded package.
You can use the [compute_metrics_reloaded.py](../compute_metrics/compute_metrics_reloaded.py) wrapper script to compute metrics using the MetricsReloaded package.

To download the script, run:

```commandline
git clone https://github.com/ivadomed/utilities.git
cd utilities/compute_metrics
conda activate metrics_reloaded
python compute_metrics_reloaded.py -h
```

Examples:

```commandline
python compute_metrics_reloaded.py
Expand Down Expand Up @@ -65,4 +76,4 @@ label values `1`, `2`, etc.; e.g., nnunet region-based).
## Useful links:
- [MetricsReloaded documentation](https://metricsreloaded.readthedocs.io/en/latest/)
- [MetricsReloaded publication](https://www.nature.com/articles/s41592-023-02151-z)
- [MetricsReloaded preprint](https://arxiv.org/pdf/2206.01653v5.pdf) - preprint contains more figures than the publication
- [MetricsReloaded preprint](https://arxiv.org/pdf/2206.01653v5.pdf) - preprint contains more figures than the publication

0 comments on commit ffb631d

Please sign in to comment.