diff --git a/README.md b/README.md index d6ed5f46..6abe4589 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,9 @@ Official repository for contrast-agnostic segmentation of the spinal cord. This repo contains all the code for training the contrast-agnostic model. The code for training is based on the [nnUNetv2 framework](https://github.com/MIC-DKFZ/nnUNet). The segmentation model is available as part of [Spinal Cord Toolbox (SCT)](https://spinalcordtoolbox.com/stable/user_section/command-line/deepseg/spinalcord.html) via the `sct_deepseg` functionality. +lifelong_ca_final + + ### Citation Information If you find this work and/or code useful for your research, please cite our paper: @@ -26,8 +29,6 @@ note = {Shared authorship -- authors contributed equally} } ``` -**TODO**: add lifelong learning figure - ## Table of contents * [Training the model ](#training-the-model) @@ -49,7 +50,7 @@ note = {Shared authorship -- authors contributed equally} 1. Create a conda environment with the following command: ```bash -conda create -n contrast_agnostic python=3.9 +conda create -n contrast_agnostic python=3.9.16 ``` 2. Activate the environment with the following command: @@ -64,8 +65,8 @@ git clone https://github.com/sct-pipeline/contrast-agnostic-softseg-spinalcord.g 3. Install the required packages with the following command: ```bash -cd contrast-agnostic-softseg-spinalcord/nnUnet -pip install -r requirements.txt +cd contrast-agnostic-softseg-spinalcord +pip install -r nnUnet/requirements.txt ``` > **Note** @@ -74,11 +75,17 @@ pip install -r requirements.txt ### Step 2: Train the model -The script `scripts/train_contrast_agnostic.sh` downloads the datasets from git-annex, creates datalists, converts them into nnUNet-specific format, and trains the model. More instructions about what variables to set and which datasets to use can be found in the script itself. Once these variables are set, the script can be run simply as follows: +The script `scripts/train_contrast_agnostic.sh` downloads the datasets from git-annex, creates datalists, converts them into nnUNet-specific format, and trains the model. More instructions about what variables to set and which datasets to use can be found in the script itself. Once these variables are set, run: ```bash bash scripts/train_contrast_agnostic.sh ``` + +> [!IMPORTANT] +> The script `train_contrast_agnostic.sh` will NOT run out-of-the-box. User-specific variables such as the path to download datasets and nnUnet repository need to be set. Info about which varibles to set can be found in the script itself. + +> [!IMPORTANT] + > You might need to run the `train_contrast_agnostic.sh` script in a virtual terminal such as `tmux` or `screen`.