Project-MONAI / Project-MONAI/MONAI

Precise Requirements Documentation

Open
#7,553 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
8.7k
Forks
1.6k
Avg merge
5d 1h
Merged PRs (30d)
20

Description

Is your feature request related to a problem? Please describe.
In the README.md and/or installation guide to precisely specify versions of dependencies. This would be only for Python, Numpy, and Pytorch at the top level and more discussion on other dependencies elsewhere.

Describe the solution you'd like
More documentation in the README.md and elsewhere.

CC @aylward @KumoLiu @Nic-Ma

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review README.md and the installation guide to identify where dependency requirements are currently described. Document precise top-level versions for Python, NumPy, and PyTorch, and add or update discussion of other dependencies elsewhere. Done means the documentation clearly distinguishes these top-level requirements from the remaining dependencies.

Written by the indexing model from the issue text.

Assessment

Tech stack
numpy, python, pytorch
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.