Skip to content

Commit d4b4bff

Browse files
ericspodpre-commit-ci[bot]KumoLiu
authored
Adding Support Policy + Doc Updates (#8458)
Addresses #8303. ### Description This adds language in the README.md file stating the support policy. There's a few things needing updating in documents that I've added as well. I've explicitly not mentioned versions of libraries in the README.md so that this doesn't go out of date, and just stated the update policy time window of support. ### 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. - [x] Documentation updated, tested `make html` command in the `docs/` folder. --------- Signed-off-by: Eric Kerfoot <eric.kerfoot@gmail.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: YunLiu <55491388+KumoLiu@users.noreply.github.com>
1 parent 222d509 commit d4b4bff

File tree

3 files changed

+16
-7
lines changed

3 files changed

+16
-7
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,9 @@ MONAI tests are located under `tests/`.
105105
A bash script (`runtests.sh`) is provided to run all tests locally.
106106
Please run ``./runtests.sh -h`` to see all options.
107107

108-
To run a particular test, for example `tests/test_dice_loss.py`:
108+
To run a particular test, for example `tests/losses/test_dice_loss.py`:
109109
```
110-
python -m tests.test_dice_loss
110+
python -m tests.losses.test_dice_loss
111111
```
112112

113113
Before submitting a pull request, we recommend that all linting and unit tests

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,15 @@ Its ambitions are as follows:
3333
- customizable design for varying user expertise;
3434
- multi-GPU multi-node data parallelism support.
3535

36+
## Requirements
37+
38+
MONAI works with the [currently supported versions of Python](https://devguide.python.org/versions), and depends directly on NumPy and PyTorch with many optional dependencies.
39+
40+
* Major releases of MONAI will have dependency versions stated for them. The current state of the `dev` branch in this repository is the unreleased development version of MONAI which typically will support current versions of dependencies and include updates and bug fixes to do so.
41+
* PyTorch support covers [the current version](https://github.com/pytorch/pytorch/releases) plus three previous minor versions. If compatibility issues with a PyTorch version and other dependencies arise, support for a version may be delayed until a major release.
42+
* Our support policy for other dependencies adheres for the most part to [SPEC0](https://scientific-python.org/specs/spec-0000), where dependency versions are supported where possible for up to two years. Discovered vulnerabilities or defects may require certain versions to be explicitly not supported.
43+
* See the `requirements*.txt` files for dependency version information.
44+
3645
## Installation
3746

3847
To install [the current release](https://pypi.org/project/monai/), you can simply run:

docs/source/installation.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,10 @@ pip install monai-weekly
5858
```
5959

6060
The weekly build is released to PyPI every Sunday with a pre-release build number `dev[%y%U]`.
61-
To report any issues on the weekly preview, please include the version and commit information:
61+
To report any issues on the weekly preview, please include the version information:
6262

6363
```bash
64-
python -c "import monai; print(monai.__version__); print(monai.__commit_id__)"
64+
python -c "import monai; print(monai.__version__)"
6565
```
6666

6767
Coexistence of package `monai` and `monai-weekly` in a system may cause namespace conflicts
@@ -101,20 +101,20 @@ for the latest features:
101101
### Option 1 (as a part of your system-wide module):
102102

103103
```bash
104-
pip install git+https://github.com/Project-MONAI/MONAI#egg=monai
104+
pip install git+https://github.com/Project-MONAI/MONAI
105105
```
106106

107107
or, to build with MONAI C++/CUDA extensions:
108108

109109
```bash
110-
BUILD_MONAI=1 pip install git+https://github.com/Project-MONAI/MONAI#egg=monai
110+
BUILD_MONAI=1 pip install git+https://github.com/Project-MONAI/MONAI
111111
```
112112

113113
To build the extensions, if the system environment already has a version of Pytorch installed,
114114
`--no-build-isolation` might be preferred:
115115

116116
```bash
117-
BUILD_MONAI=1 pip install --no-build-isolation git+https://github.com/Project-MONAI/MONAI#egg=monai
117+
BUILD_MONAI=1 pip install --no-build-isolation git+https://github.com/Project-MONAI/MONAI
118118
```
119119

120120
this command will download and install the current `dev` branch of [MONAI from

0 commit comments

Comments
 (0)