Skip to content

Commit

Permalink
Clarify installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
valosekj authored Jun 1, 2024
1 parent ffb631d commit d77d79b
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions quick_start_guides/MetricsReloaded_quick_start_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,16 @@

## Installation

The installation instructions are available [here](https://github.com/ivadomed/MetricsReloaded?tab=readme-ov-file#installation).
ℹ️ Note that we use the [ivadomed fork](https://github.com/ivadomed/MetricsReloaded) of the MetricsReloaded repository.

> **Note**
> Note that we use an ivadomed fork.

> **Note**
> Always install MetricsReloaded inside a virtual environment.
⚠️ Always install MetricsReloaded inside a virtual environment:

```
# Create and activate a new conda environment
conda create -n metrics_reloaded python=3.10 pip
conda activate metrics_reloaded
# Clone the repository
# Clone the MetricsReloaded repository (ivadomed fork)
cd ~/code
git clone https://github.com/ivadomed/MetricsReloaded
cd MetricsReloaded
Expand All @@ -27,20 +22,23 @@ python -m pip install .
python -m pip install -e .
```

The installation instructions are available also [here](https://github.com/ivadomed/MetricsReloaded?tab=readme-ov-file#installation).

## Usage

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
cd ~/code
git clone https://github.com/ivadomed/utilities.git
cd utilities/compute_metrics
conda activate metrics_reloaded
python compute_metrics_reloaded.py -h
```

Examples:
Example usage:

```commandline
python compute_metrics_reloaded.py
Expand Down

0 comments on commit d77d79b

Please sign in to comment.