Skip to content

Commit 865b0e7

Browse files
authored
Update documentation links (#8637)
Fixes #8598 . ### Description Update links to: Website: https://project-monai.github.io/ Core Docs: https://monai.readthedocs.io/en/stable/ Label Docs: https://monai.readthedocs.io/projects/label/en/latest/ Deploy SDK Docs: https://monai.readthedocs.io/projects/monai-deploy-app-sdk/en/stable/ ### Types of changes <!--- Put an `x` in all the boxes that apply, and remove the not applicable items --> - [x] Non-breaking change (fix or new feature that would not break existing functionality). - [ ] Breaking change (fix or new feature that would cause existing functionality to change). - [ ] New tests added to cover the changes. - [ ] Integration tests passed locally by running `./runtests.sh -f -u --net --coverage`. - [ ] Quick tests passed locally by running `./runtests.sh --quick --unittests --disttests`. - [ ] In-line docstrings updated. - [ ] Documentation updated, tested `make html` command in the `docs/` folder. Signed-off-by: Yun Liu <[email protected]>
1 parent c968907 commit 865b0e7

File tree

25 files changed

+60
-60
lines changed

25 files changed

+60
-60
lines changed

CITATION.cff

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ identifiers:
1414
value: "10.5281/zenodo.4323058"
1515
license: "Apache-2.0"
1616
repository-code: "https://github.com/Project-MONAI/MONAI"
17-
url: "https://monai.io"
17+
url: "https://project-monai.github.io/"
1818
cff-version: "1.2.0"
1919
message: "If you use this software, please cite it using these metadata."
2020
preferred-citation:

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ The first line of the comment must be `/black` so that it will be interpreted by
198198
#### Adding new optional dependencies
199199

200200
In addition to the minimal requirements of PyTorch and Numpy, MONAI's core modules are built optionally based on 3rd-party packages.
201-
The current set of dependencies is listed in [installing dependencies](https://docs.monai.io/en/stable/installation.html#installing-the-recommended-dependencies).
201+
The current set of dependencies is listed in [installing dependencies](https://monai.readthedocs.io/en/stable/installation.html#installing-the-recommended-dependencies).
202202

203203
To allow for flexible integration of MONAI with other systems and environments,
204204
the optional dependency APIs are always invoked lazily. For example,

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
[![premerge](https://github.com/Project-MONAI/MONAI/actions/workflows/pythonapp.yml/badge.svg?branch=dev)](https://github.com/Project-MONAI/MONAI/actions/workflows/pythonapp.yml)
1515
[![postmerge](https://img.shields.io/github/checks-status/project-monai/monai/dev?label=postmerge)](https://github.com/Project-MONAI/MONAI/actions?query=branch%3Adev)
16-
[![Documentation Status](https://readthedocs.org/projects/monai/badge/?version=latest)](https://docs.monai.io/en/latest/)
16+
[![Documentation Status](https://readthedocs.org/projects/monai/badge/?version=latest)](https://monai.readthedocs.io/en/latest/)
1717
[![codecov](https://codecov.io/gh/Project-MONAI/MONAI/branch/dev/graph/badge.svg?token=6FTC7U1JJ4)](https://codecov.io/gh/Project-MONAI/MONAI)
1818
[![monai Downloads Last Month](https://assets.piptrends.com/get-last-month-downloads-badge/monai.svg 'monai Downloads Last Month by pip Trends')](https://piptrends.com/package/monai)
1919

@@ -26,7 +26,7 @@ Its ambitions are as follows:
2626

2727
## Features
2828

29-
> _Please see [the technical highlights](https://docs.monai.io/en/latest/highlights.html) and [What's New](https://docs.monai.io/en/latest/whatsnew.html) of the milestone releases._
29+
> _Please see [the technical highlights](https://monai.readthedocs.io/en/latest/highlights.html) and [What's New](https://monai.readthedocs.io/en/latest/whatsnew.html) of the milestone releases._
3030
3131
- flexible pre-processing for multi-dimensional medical imaging data;
3232
- compositional & portable APIs for ease of integration in existing workflows;
@@ -51,7 +51,7 @@ To install [the current release](https://pypi.org/project/monai/), you can simpl
5151
pip install monai
5252
```
5353

54-
Please refer to [the installation guide](https://docs.monai.io/en/latest/installation.html) for other installation options.
54+
Please refer to [the installation guide](https://monai.readthedocs.io/en/latest/installation.html) for other installation options.
5555

5656
## Getting Started
5757

@@ -68,7 +68,7 @@ If you have used MONAI in your research, please cite us! The citation can be exp
6868
## Model Zoo
6969

7070
[The MONAI Model Zoo](https://github.com/Project-MONAI/model-zoo) is a place for researchers and data scientists to share the latest and great models from the community.
71-
Utilizing [the MONAI Bundle format](https://docs.monai.io/en/latest/bundle_intro.html) makes it easy to [get started](https://github.com/Project-MONAI/tutorials/tree/main/model_zoo) building workflows with MONAI.
71+
Utilizing [the MONAI Bundle format](https://monai.readthedocs.io/en/latest/bundle_intro.html) makes it easy to [get started](https://github.com/Project-MONAI/tutorials/tree/main/model_zoo) building workflows with MONAI.
7272

7373
## Contributing
7474

@@ -82,9 +82,9 @@ Ask and answer questions over on [MONAI's GitHub Discussions tab](https://github
8282

8383
## Links
8484

85-
- Website: <https://monai.io/>
86-
- API documentation (milestone): <https://docs.monai.io/>
87-
- API documentation (latest dev): <https://docs.monai.io/en/latest/>
85+
- Website: <https://project-monai.github.io/>
86+
- API documentation (milestone): <https://monai.readthedocs.io/>
87+
- API documentation (latest dev): <https://monai.readthedocs.io/en/latest/>
8888
- Code: <https://github.com/Project-MONAI/MONAI>
8989
- Project tracker: <https://github.com/Project-MONAI/MONAI/projects>
9090
- Issue tracker: <https://github.com/Project-MONAI/MONAI/issues>

docs/source/applications.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
# Research and Application Highlights
22

33
### COPLE-Net for COVID-19 Pneumonia Lesion Segmentation
4-
[A reimplementation](https://monai.io/research/coplenet-pneumonia-lesion-segmentation) of the COPLE-Net originally proposed by:
4+
[A reimplementation](https://project-monai.github.io/research/coplenet-pneumonia-lesion-segmentation.html) of the COPLE-Net originally proposed by:
55

66
G. Wang, X. Liu, C. Li, Z. Xu, J. Ruan, H. Zhu, T. Meng, K. Li, N. Huang, S. Zhang. (2020) "A Noise-robust Framework for Automatic Segmentation of COVID-19 Pneumonia Lesions from CT Images." IEEE Transactions on Medical Imaging. 2020. [DOI: 10.1109/TMI.2020.3000314](https://doi.org/10.1109/TMI.2020.3000314)
77
![coplenet](../images/coplenet.png)
88

99
### LAMP: Large Deep Nets with Automated Model Parallelism for Image Segmentation
10-
[A reimplementation](https://monai.io/research/lamp-automated-model-parallelism) of the LAMP system originally proposed by:
10+
[A reimplementation](https://project-monai.github.io/research/lamp-automated-model-parallelism.html) of the LAMP system originally proposed by:
1111

1212
Wentao Zhu, Can Zhao, Wenqi Li, Holger Roth, Ziyue Xu, and Daguang Xu (2020) "LAMP: Large Deep Nets with Automated Model Parallelism for Image Segmentation." MICCAI 2020 (Early Accept, paper link: https://arxiv.org/abs/2006.12575)
1313

1414
![LAMP UNet](../images/unet-pipe.png)
1515

1616
### DiNTS: Differentiable Neural Network Topology Search for 3D Medical Image Segmentation
17-
MONAI integrated the `DiNTS` module to support more flexible topologies and joint two-level search. It provides a topology guaranteed discretization algorithm and a discretization aware topology loss for the search stage to minimize the discretization gap, and a cost usage aware search method which can search 3D networks with different GPU memory requirements. For more details, please check the [DiNTS tutorial](https://monai.io/research/dints.html).
17+
MONAI integrated the `DiNTS` module to support more flexible topologies and joint two-level search. It provides a topology guaranteed discretization algorithm and a discretization aware topology loss for the search stage to minimize the discretization gap, and a cost usage aware search method which can search 3D networks with different GPU memory requirements. For more details, please check the [DiNTS tutorial](https://project-monai.github.io/research/dints.html).
1818

1919
![DiNTS](../images/dints-overview.png)
2020

docs/source/config_syntax.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ or additionally, tune the input parameters then instantiate the component:
6868
BasicUNet features: (32, 32, 32, 64, 64, 64).
6969
```
7070

71-
For more details on the `ConfigParser` API, please see [`monai.bundle.ConfigParser`](https://docs.monai.io/en/latest/bundle.html#config-parser).
71+
For more details on the `ConfigParser` API, please see [`monai.bundle.ConfigParser`](https://monai.readthedocs.io/en/latest/bundle.html#config-parser).
7272

7373
## Syntax examples explained
7474

docs/source/index.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -85,15 +85,15 @@ Model Zoo
8585
---------
8686

8787
`The MONAI Model Zoo <https://github.com/Project-MONAI/model-zoo>`_ is a place for researchers and data scientists to share the latest and great models from the community.
88-
Utilizing `the MONAI Bundle format <https://docs.monai.io/en/latest/bundle_intro.html>`_ makes it easy to `get started <https://github.com/Project-MONAI/tutorials/tree/main/model_zoo>`_ building workflows with MONAI.
88+
Utilizing `the MONAI Bundle format <https://monai.readthedocs.io/en/latest/bundle_intro.html>`_ makes it easy to `get started <https://github.com/Project-MONAI/tutorials/tree/main/model_zoo>`_ building workflows with MONAI.
8989

9090

9191
Links
9292
-----
9393

94-
- Website: https://monai.io/
95-
- API documentation (milestone): https://docs.monai.io/
96-
- API documentation (latest dev): https://docs.monai.io/en/latest/
94+
- Website: https://project-monai.github.io/
95+
- API documentation (milestone): https://monai.readthedocs.io/
96+
- API documentation (latest dev): https://monai.readthedocs.io/en/latest/
9797
- Code: https://github.com/Project-MONAI/MONAI
9898
- Project tracker: https://github.com/Project-MONAI/MONAI/projects
9999
- Issue tracker: https://github.com/Project-MONAI/MONAI/issues

docs/source/modules.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ users and programs to understand how the model is used and for what purpose. A b
240240
single network as a pickled state dictionary plus optionally a Torchscript object and/or an ONNX object. Additional JSON
241241
files are included to store metadata about the model, information for constructing training, inference, and
242242
post-processing transform sequences, plain-text description, legal information, and other data the model creator wishes
243-
to include. More details are available at [bundle specification](https://docs.monai.io/en/latest/mb_specification.html).
243+
to include. More details are available at [bundle specification](https://monai.readthedocs.io/en/latest/mb_specification.html).
244244

245245
The key benefits of bundle are to define the model package and support building Python-based workflows via structured configurations:
246246
- Self-contained model package include all the necessary information.
@@ -262,34 +262,34 @@ A typical bundle example can include:
262262
┣━ *README.md
263263
┗━ *license.txt
264264
```
265-
Details about the bundle config definition and syntax & examples are at [config syntax](https://docs.monai.io/en/latest/config_syntax.html).
265+
Details about the bundle config definition and syntax & examples are at [config syntax](https://monai.readthedocs.io/en/latest/config_syntax.html).
266266
A step-by-step [get started](https://github.com/Project-MONAI/tutorials/blob/main/bundle/README.md) tutorial notebook can help users quickly set up a bundle. [[bundle examples](https://github.com/Project-MONAI/tutorials/tree/main/bundle), [model-zoo](https://github.com/Project-MONAI/model-zoo)]
267267

268268
## Federated Learning
269269

270270
![federated-learning](../images/federated.svg)
271271

272-
Using the MONAI bundle configurations, we can use MONAI's [`MonaiAlgo`](https://docs.monai.io/en/latest/fl.html#monai.fl.client.MonaiAlgo)
273-
class, an implementation of the abstract [`ClientAlgo`](https://docs.monai.io/en/latest/fl.html#clientalgo) class for federated learning (FL),
272+
Using the MONAI bundle configurations, we can use MONAI's [`MonaiAlgo`](https://monai.readthedocs.io/en/latest/fl.html#monai.fl.client.MonaiAlgo)
273+
class, an implementation of the abstract [`ClientAlgo`](https://monai.readthedocs.io/en/latest/fl.html#clientalgo) class for federated learning (FL),
274274
to execute bundles from the [MONAI model zoo](https://github.com/Project-MONAI/model-zoo).
275-
Note that [`ClientAlgo`](https://docs.monai.io/en/latest/fl.html#clientalgo) is provided as an abstract base class for
275+
Note that [`ClientAlgo`](https://monai.readthedocs.io/en/latest/fl.html#clientalgo) is provided as an abstract base class for
276276
defining an algorithm to be run on any federated learning platform.
277-
[`MonaiAlgo`](https://docs.monai.io/en/latest/fl.html#monai.fl.client.MonaiAlgo) implements the main functionalities needed
277+
[`MonaiAlgo`](https://monai.readthedocs.io/en/latest/fl.html#monai.fl.client.MonaiAlgo) implements the main functionalities needed
278278
to run federated learning experiments, namely `train()`, `get_weights()`, and `evaluate()`, that can be run using single- or multi-GPU training.
279279
On top, it provides implementations for life-cycle management of the component such as `initialize()`, `abort()`, and `finalize()`.
280280
The MONAI FL client also allows computing summary data statistics (e.g., intensity histograms) on the datasets defined in the bundle configs
281-
using the [`MonaiAlgoStats`](https://docs.monai.io/en/latest/fl.html#monai.fl.client.MonaiAlgoStats) class.
281+
using the [`MonaiAlgoStats`](https://monai.readthedocs.io/en/latest/fl.html#monai.fl.client.MonaiAlgoStats) class.
282282
These statistics can be shared and visualized on the FL server.
283283
[NVIDIA FLARE](https://github.com/NVIDIA/NVFlare), the federated learning platform developed by NVIDIA, has already built [the integration piece](https://github.com/NVIDIA/NVFlare/tree/2.2/integration/monai)
284-
with [`ClientAlgo`](https://docs.monai.io/en/latest/fl.html#clientalgo) to allow easy experimentation with MONAI bundles within their federated environment.
284+
with [`ClientAlgo`](https://monai.readthedocs.io/en/latest/fl.html#clientalgo) to allow easy experimentation with MONAI bundles within their federated environment.
285285
Our [[federated learning tutorials]](https://github.com/Project-MONAI/tutorials/tree/main/federated_learning/nvflare) shows
286286
examples of single- & multi-GPU training and federated statistics workflows.
287287

288288
## Auto3dseg
289289

290290
![auto3dseg](../images/auto3dseg.png)
291291

292-
[Auto3DSeg](https://monai.io/apps/auto3dseg.html) is a comprehensive solution for large-scale 3D medical image segmentation.
292+
[Auto3DSeg](https://project-monai.github.io/apps/auto3dseg.html) is a comprehensive solution for large-scale 3D medical image segmentation.
293293
It leverages the latest advances in MONAI
294294
and GPUs to efficiently develop and deploy algorithms with state-of-the-art performance.
295295
It first analyzes the global information such as intensity, dimensionality, and resolution of the dataset,

docs/source/whatsnew_0_6.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The following illustrates target body organs that are segmentation in this tutor
4242
![BTCV_organs](../images/BTCV_organs.png)
4343

4444
Please visit UNETR repository for more details:
45-
https://monai.io/research/unetr-btcv-multi-organ-segmentation
45+
https://project-monai.github.io/research/unetr-btcv-multi-organ-segmentation
4646

4747
## Pythonic APIs to load the pretrained models from Clara Train MMARs
4848
[The MMAR (Medical Model ARchive)](https://docs.nvidia.com/clara/clara-train-sdk/pt/mmar.html)
@@ -93,4 +93,4 @@ MONAI Label enables application developers to build labeling apps in a serverles
9393
where custom labeling apps are exposed as a service through the MONAI Label Server.
9494

9595
Please visit MONAILabel documentation website for details:
96-
https://docs.monai.io/projects/label/en/latest/
96+
https://monai.readthedocs.io/projects/label/en/latest/

docs/source/whatsnew_0_8.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ It provides a topology guaranteed discretization algorithm and a
1515
discretization-aware topology loss for the search stage to minimize the
1616
discretization gap. The module is memory usage aware and is able to search 3D
1717
networks with different GPU memory requirements. For more details, please check out the
18-
[DiNTS tutorial](https://monai.io/research/dints.html).
18+
[DiNTS tutorial](https://project-monai.github.io/research/dints.html).
1919

2020
![DiNTS](../images/dints-overview.png)
2121

docs/source/whatsnew_0_9.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
- MetaTensor API preview
88

99
## MONAI Bundle
10-
MONAI Bundle format defines portable described of deep learning models ([docs](https://docs.monai.io/en/latest/bundle_intro.html)).
10+
MONAI Bundle format defines portable described of deep learning models ([docs](https://monai.readthedocs.io/en/latest/bundle_intro.html)).
1111
A bundle includes the critical information necessary during a model development life cycle,
1212
and allows users and programs to understand the purpose and usage of the models.
1313
The key benefits of Bundle and the `monai.bundle` APIs are:

0 commit comments

Comments
 (0)