Skip to content

Commit f463d02

Browse files
Update links for MONAI website and docs (#1876)
* Update documentation URLs to use GitHub Pages and ReadTheDocs Replace references to monai.io domain with project-monai.github.io for the website and monai.readthedocs.io for documentation. * Update Slack channel invite link --------- Co-authored-by: SACHIDANAND ALLE <sachidanand.alle@gmail.com>
1 parent e689ab5 commit f463d02

4 files changed

Lines changed: 17 additions & 17 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ limitations under the License.
1414
# MONAI Label
1515
[![License](https://img.shields.io/badge/license-Apache%202.0-green.svg)](https://opensource.org/licenses/Apache-2.0)
1616
[![CI Build](https://github.com/Project-MONAI/MONAILabel/workflows/build/badge.svg?branch=main)](https://github.com/Project-MONAI/MONAILabel/commits/main)
17-
[![Documentation Status](https://readthedocs.org/projects/monailabel/badge/?version=latest)](https://docs.monai.io/projects/label/en/latest/?badge=latest)
17+
[![Documentation Status](https://readthedocs.org/projects/monailabel/badge/?version=latest)](https://monai.readthedocs.io/projects/label/en/latest/?badge=latest)
1818
[![PyPI version](https://badge.fury.io/py/monailabel.svg)](https://badge.fury.io/py/monailabel)
1919
[![Azure DevOps tests (compact)](https://img.shields.io/azure-devops/tests/projectmonai/monai-label/10?compact_message)](https://dev.azure.com/projectmonai/monai-label/_test/analytics?definitionId=10&contextType=build)
2020
[![Azure DevOps coverage](https://img.shields.io/azure-devops/coverage/projectmonai/monai-label/10)](https://dev.azure.com/projectmonai/monai-label/_build?definitionId=10)
@@ -27,7 +27,7 @@ open-source and easy-to-install ecosystem that can run locally on a machine with
2727
and client work on the same/different machine. It shares the same principles
2828
with [MONAI](https://github.com/Project-MONAI).
2929

30-
Refer to full [MONAI Label documentations](https://docs.monai.io/projects/label/en/latest/index.html) for more details or check out our [MONAI Label Deep Dive videos series](https://www.youtube.com/playlist?list=PLtoSVSQ2XzyD4lc-lAacFBzOdv5Ou-9IA).
30+
Refer to full [MONAI Label documentations](https://monai.readthedocs.io/projects/label/en/latest/index.html) for more details or check out our [MONAI Label Deep Dive videos series](https://www.youtube.com/playlist?list=PLtoSVSQ2XzyD4lc-lAacFBzOdv5Ou-9IA).
3131

3232
Refer to [MONAI Label Tutorial](https://github.com/Project-MONAI/tutorials/tree/main/monailabel) series for application and viewer workflows with different medical image tasks. Notebook-like tutorials are created for detailed instructions.
3333

@@ -182,8 +182,8 @@ In addition, you can find a table of the basic supported fields, modalities, vie
182182
<pre>pip install -U monailabel</pre>
183183

184184
MONAI Label supports the following OS with **GPU/CUDA** enabled. For more details instruction, please see the installation guides.
185-
- [Ubuntu](https://docs.monai.io/projects/label/en/latest/installation.html)
186-
- [Windows](https://docs.monai.io/projects/label/en/latest/installation.html#windows)
185+
- [Ubuntu](https://monai.readthedocs.io/projects/label/en/latest/installation.html)
186+
- [Windows](https://monai.readthedocs.io/projects/label/en/latest/installation.html#windows)
187187

188188
### GPU Acceleration (Optional Dependencies)
189189
Following are the optional dependencies which can help you to accelerate some GPU based transforms from MONAI. These dependencies are enabled by default if you are using `projectmonai/monailabel` docker.
@@ -401,15 +401,15 @@ the [contributing guidelines](https://github.com/Project-MONAI/MONAILabel/blob/m
401401
## Community
402402

403403
Join the conversation on Twitter [@ProjectMONAI](https://twitter.com/ProjectMONAI) or join
404-
our [Slack channel](https://projectmonai.slack.com/archives/C031QRE0M1C).
404+
our [Slack channel](https://join.slack.com/t/projectmonai/shared_invite/zt-3hucgm02q-i8Bn9XofDZs2UGOH4jUl4w).
405405

406406
Ask and answer questions over
407407
on [MONAI Label's GitHub Discussions tab](https://github.com/Project-MONAI/MONAILabel/discussions).
408408

409409
## Additional Resources
410410

411-
- Website: https://monai.io/
412-
- API documentation: https://docs.monai.io/projects/label
411+
- Website: https://project-monai.github.io/
412+
- API documentation: https://monai.readthedocs.io/projects/label
413413
- Code: https://github.com/Project-MONAI/MONAILabel
414414
- Project tracker: https://github.com/Project-MONAI/MONAILabel/projects
415415
- Issue tracker: https://github.com/Project-MONAI/MONAILabel/issues

sample-apps/endoscopy/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ interactive and automated segmentation.
106106
</summary>
107107
This model is currently trained to segment **Tool** from 2D in-body images.
108108

109-
- Network: This model uses the [BasicUNet](https://docs.monai.io/en/latest/networks.html#basicunet) as the default network.
109+
- Network: This model uses the [BasicUNet](https://monai.readthedocs.io/en/stable/networks.html#basicunet) as the default network.
110110
- Labels: `{ "Tool": 1 }`
111111
- Dataset: The model is pre-trained over few in-body Images related to Endoscopy
112112
- Inputs: 3 channels.
@@ -119,7 +119,7 @@ This model is currently trained to segment **Tool** from 2D in-body images.
119119
<summary>
120120
<strong>ToolTracking</strong> is based on UNet for automated segmentation. This model works for single label segmentation tasks.
121121
</summary>
122-
- Network: This model uses the [FlexibleUNet](https://docs.monai.io/en/latest/networks.html#flexibleunet) as the default network.
122+
- Network: This model uses the [FlexibleUNet](https://monai.readthedocs.io/en/stable/networks.html#flexibleunet) as the default network.
123123
- Labels: `{ "Tool": 1 }`
124124
- Dataset: The model is pre-trained over few in-body Images related to Endoscopy
125125
- Inputs: 1 channel for the image modality
@@ -130,7 +130,7 @@ This model is currently trained to segment **Tool** from 2D in-body images.
130130
<summary>
131131
<strong>InBody/OutBody</strong> is based on SEResNet50 for classification. This model determines if tool is present or not (in-body vs out-body).
132132
</summary>
133-
- Network: This model uses the [SEResNet50](https://docs.monai.io/en/latest/networks.html#seresnet50) as the default network.
133+
- Network: This model uses the [SEResNet50](https://monai.readthedocs.io/en/stable/networks.html#seresnet50) as the default network.
134134
- Labels: `{ "InBody": 0, "OutBody": 1 }`
135135
- Dataset: The model is pre-trained over few in-body Images related to Endoscopy
136136
- Inputs: 1 channel for the image modality

sample-apps/monaibundle/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ limitations under the License.
1414
# MONAI Bundle Application
1515
The MONAIBundle App allows you to easily pull any MONAI Bundle from the [MONAI Model Zoo](https://github.com/Project-MONAI/model-zoo/tree/dev/models) and import it into MONAI Label. However, it's important to note that any MONAI Bundle used with MONAI Label must meet the following constraints:
1616

17-
- It must comply with the [MONAI Bundle Specification](https://docs.monai.io/en/latest/mb_specification.html).
17+
- It must comply with the [MONAI Bundle Specification](https://monai.readthedocs.io/en/stable/mb_specification.html).
1818
- For inference, the bundle must define either an `inference.json` or `inference.yaml` file, and it must include the keys described in the bundle.py file located in the `monailabel/tasks/infer/` directory.
1919
- For training, the bundle must define either a `train.json` or `train.yaml file`, and it must include the keys described in the bundle.py file located in the `monailabel/tasks/train/` directory.
2020
- For multi-GPU training, the bundle must define either a `multi_gpu_train.json` or `multi_gpu_train.yaml` file.

sample-apps/radiology/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ monailabel start_server --app workspace/radiology --studies workspace/images --c
6767

6868
### Hybrid Radiology App with Models and Bundles
6969

70-
Radiology app now supports loading models from local or from bundles in [MONAI Model Zoo](https://monai.io/model-zoo)
70+
Radiology app now supports loading models from local or from bundles in [MONAI Model Zoo](https://project-monai.github.io/model-zoo)
7171

7272
```bash
7373
# Example: Pick two models of spleen and multi-organ segmentation model, and two model-zoo bundles.
@@ -106,7 +106,7 @@ A command example to use active learning strategies with DeepEdit would be:
106106

107107
> monailabel start_server --app workspace/radiology --studies workspace/images --conf models deepedit --conf skip_scoring false --conf skip_strategies false --conf epistemic_enabled true
108108
109-
- Network: This model uses the DynUNet as the default network. It also comes with pretrained model for [UNETR](https://docs.monai.io/en/latest/networks.html#unetr). Researchers can define their own network or use one of the listed [here](https://docs.monai.io/en/latest/networks.html)
109+
- Network: This model uses the DynUNet as the default network. It also comes with pretrained model for [UNETR](https://monai.readthedocs.io/en/stable/networks.html#unetr). Researchers can define their own network or use one of the listed [here](https://monai.readthedocs.io/en/stable/networks.html)
110110
- Labels:
111111
```json
112112
{
@@ -151,7 +151,7 @@ the model to learn on new organ.
151151
|----------------------|--------------------|-----------------------------------------------------------------|
152152
| preload | true, **false** | Preload model into GPU |
153153

154-
- Network: This App uses the [BasicUNet](https://docs.monai.io/en/latest/networks.html#basicunet) as the default network.
154+
- Network: This App uses the [BasicUNet](https://monai.readthedocs.io/en/stable/networks.html#basicunet) as the default network.
155155
- Labels:
156156
```json
157157
[
@@ -191,7 +191,7 @@ the model to learn on new organ.
191191
| preload | true, **false** | Preload model into GPU |
192192
| scribbles | **true**, false | Don't load the scribble models, useful for user studies |
193193

194-
- Network: This model uses the [UNet](https://docs.monai.io/en/latest/networks.html#unet) as the default network. Researchers can define their own network or use one of the listed [here](https://docs.monai.io/en/latest/networks.html)
194+
- Network: This model uses the [UNet](https://monai.readthedocs.io/en/stable/networks.html#unet) as the default network. Researchers can define their own network or use one of the listed [here](https://monai.readthedocs.io/en/stable/networks.html)
195195
- Labels
196196
```json
197197
{
@@ -242,7 +242,7 @@ A command example to use active learning strategies with segmentation_spleen wou
242242
> monailabel start_server --app workspace/radiology --studies workspace/images --conf models segmentation_spleen --conf skip_scoring false --conf skip_strategies false --conf epistemic_enabled true
243243
244244

245-
- Network: This App uses the [UNet](https://docs.monai.io/en/latest/networks.html#unet) as the default network.
245+
- Network: This App uses the [UNet](https://monai.readthedocs.io/en/stable/networks.html#unet) as the default network.
246246
- Labels: `{ "Spleen": 1 }`
247247
- Dataset: The model is pre-trained over dataset: http://medicaldecathlon.com/
248248
- Inputs: 1 channel for the image modality
@@ -280,7 +280,7 @@ The difference between second and third stage is that third stage get a more fin
280280
|----------------------|--------------------|-----------------------------------------------------------------|
281281
| use_pretrained_model | **true**, false | Disable this NOT to load any pretrained weights |
282282

283-
- Network: This App uses the [UNet](https://docs.monai.io/en/latest/networks.html#unet) as the default network.
283+
- Network: This App uses the [UNet](https://monai.readthedocs.io/en/stable/networks.html#unet) as the default network.
284284
- Labels:
285285
```json
286286
{

0 commit comments

Comments
 (0)