Skip to content
This repository was archived by the owner on Mar 21, 2024. It is now read-only.

Commit 5336a67

Browse files
authored
Fix Markdown linting errors (#684)
1 parent b1f3ef5 commit 5336a67

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ or patient characteristics are often available in addition to images.
2222
On the user side, this toolbox focusses on enabling machine learning teams to achieve more. It is cloud-first, and
2323
relies on [Azure Machine Learning Services (AzureML)](https://docs.microsoft.com/en-gb/azure/machine-learning/) for execution,
2424
bookkeeping, and visualization. Taken together, this gives:
25+
2526
- **Traceability**: AzureML keeps a full record of all experiments that were executed, including a snapshot of
2627
the code. Tags are added to the experiments automatically, that can later help filter and find old experiments.
2728
- **Transparency**: All team members have access to each other's experiments and results.
@@ -37,7 +38,8 @@ model prototyping, debugging, and in cases where the cloud can't be used. In par
3738
machines available, you will be able to utilize them with the InnerEye toolbox.
3839

3940
In addition, our toolbox supports:
40-
- Cross-validation using AzureML's built-in support, where the models for
41+
42+
- Cross-validation using AzureML's built-in support, where the models for
4143
individual folds are trained in parallel. This is particularly important for the long-running training jobs
4244
often seen with medical images.
4345
- Hyperparameter tuning using
@@ -49,40 +51,47 @@ architecture.
4951
Once training in AzureML is done, the models can be deployed from within AzureML or via
5052
[Azure Stack Hub](https://azure.microsoft.com/en-us/products/azure-stack/hub/).
5153

52-
5354
## Getting started
5455

5556
We recommend using our toolbox with Linux or with the Windows Subsystem for Linux (WSL2). Much of the core
5657
functionality works fine on Windows, but PyTorch's full feature set is only available on Linux. Read [more about
5758
WSL here](docs/WSL.md).
5859

5960
Clone the repository into a subfolder of the current directory:
60-
```shell script
61+
62+
```shell
6163
git clone --recursive https://github.com/microsoft/InnerEye-DeepLearning
6264
cd InnerEye-DeepLearning
6365
git lfs install
6466
git lfs pull
6567
```
68+
6669
After that, you need to set up your Python environment:
70+
6771
- Install `conda` or `miniconda` for your operating system.
6872
- Create a Conda environment from the `environment.yml` file in the repository root, and activate it:
69-
```shell script
73+
74+
```shell
7075
conda env create --file environment.yml
7176
conda activate InnerEye
7277
```
73-
- If environment creation fails with odd error messages on a Windows machine, please [continue here](docs/WSL.md).
7478

75-
Now try to run the HelloWorld segmentation model - that's a very simple model that will train for 2 epochs on any
79+
- If the environment creation fails with odd error messages on a Windows machine, please [continue here](docs/WSL.md).
80+
81+
Now try to run the `HelloWorld` segmentation model - that's a very simple model that will train for 2 epochs on any
7682
machine, no GPU required. You need to set the `PYTHONPATH` environment variable to point to the repository root first.
7783
Assuming that your current directory is the repository root folder, on Linux `bash` that is:
78-
```shell script
84+
85+
```shell
7986
export PYTHONPATH=`pwd`
8087
python InnerEye/ML/runner.py --model=HelloWorld
8188
```
89+
8290
(Note the "backtick" around the `pwd` command, this is not a standard single quote!)
8391

8492
On Windows:
85-
```shell script
93+
94+
```shell
8695
set PYTHONPATH=%cd%
8796
python InnerEye/ML/runner.py --model=HelloWorld
8897
```
@@ -93,6 +102,7 @@ If it fails, please check the
93102
[troubleshooting page on the Wiki](https://github.com/microsoft/InnerEye-DeepLearning/wiki/Issues-with-code-setup-and-the-HelloWorld-model).
94103

95104
Further detailed instructions, including setup in Azure, are here:
105+
96106
1. [Setting up your environment](docs/environment.md)
97107
1. [Training a Hello World segmentation model](docs/hello_world_model.md)
98108
1. [Setting up Azure Machine Learning](docs/setting_up_aml.md)
@@ -106,8 +116,10 @@ Further detailed instructions, including setup in Azure, are here:
106116
1. [Active label cleaning and noise robust learning toolbox](InnerEye-DataQuality/README.md)
107117

108118
## Deployment
119+
109120
We offer a companion set of open-sourced tools that help to integrate trained CT segmentation models with clinical
110121
software systems:
122+
111123
- The [InnerEye-Gateway](https://github.com/microsoft/InnerEye-Gateway) is a Windows service running in a DICOM network,
112124
that can route anonymized DICOM images to an inference service.
113125
- The [InnerEye-Inference](https://github.com/microsoft/InnerEye-Inference) component offers a REST API that integrates
@@ -158,7 +170,7 @@ Bernhardt M., Castro D. C., Tanno R., Schwaighofer A., Tezcan K. C., Monteiro M.
158170

159171
This project welcomes contributions and suggestions. Most contributions require you to agree to a
160172
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
161-
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
173+
the rights to use your contribution. For details, visit [https://cla.opensource.microsoft.com](https://cla.opensource.microsoft.com).
162174

163175
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
164176
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
@@ -168,7 +180,6 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
168180
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
169181
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
170182

171-
172183
## Credits
173184

174185
This toolbox is maintained by the

0 commit comments

Comments
 (0)