Skip to content

Fix typo in documentation #754

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: dev
Choose a base branch
from

Conversation

mingxin-zheng
Copy link
Contributor

Fixes #753 .

Description

Fix documenation error via ChatGPT Codex. Prompt used:

Please navigate through the documentation of the models and find typo and documentation bugs.

Status

Ready/Work in progress/Hold

Please ensure all the checkboxes:

  • Codeformat tests passed locally by running ./runtests.sh --codeformat.
  • In-line docstrings updated.
  • Update version and changelog in metadata.json if changing an existing bundle.
  • Please ensure the naming rules in config files meet our requirements (please refer to: CONTRIBUTING.md).
  • Ensure versions of packages such as monai, pytorch and numpy are correct in metadata.json.
  • Descriptions should be consistent with the content, such as eval_metrics of the provided weights and TorchScript modules.
  • Files larger than 25MB are excluded and replaced by providing download links in large_file.yml.
  • Avoid using path that contains personal information within config files (such as use /home/your_name/ for "bundle_root").

Signed-off-by: Mingxin Zheng <[email protected]>
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request fixes several typos and minor spelling errors in the documentation across multiple model bundles. The changes improve clarity and correctness in file content without impacting functionality.

  • Fixed spelling of “datasets”, “registration”, “finetuning”/“finetuning”, “Hyperparameters”, “override”, etc.
  • Updated names for consistency such as “MONAI Label” replacing “MONAI Lable” or “MONAILable.”
  • Corrected several other minor errors in markdown documentation.

Reviewed Changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 12 comments.

Show a summary per file
File Description
models/wholeBrainSeg_Large_UNEST_segmentation/docs/README.md Corrected typos in dataset names, registration tool reference, and labeling for MONAI.
models/vista3d/docs/inference.md Fixed spelling error in the word "segmentation."
models/vista3d/docs/finetune.md Corrected the typo "substructuress" to "substructures."
models/vista3d/docs/data.md Fixed spelling error "exampls" to "examples."
models/vista3d/docs/README.md Fixed multiple typos: "fintuning" to "finetuning", "Hyperparameteers" to "Hyperparameters", and "overide" to "override."
models/vista2d/docs/README.md Corrected "ditectory" to "directory."
models/ventricular_short_axis_3label/docs/README.md Changed "Guassian" to "Gaussian" in noise description.
models/segmentation_template/docs/README.md Updated "MONAILable" to "MONAI Label."
models/lung_nodule_ct_detection/docs/README.md Changed "following" to "follow" in resampling instruction.
models/cxr_image_synthesis_latent_diffusion_model/docs/README.md Fixed typo "randoomly" to "randomly" in the preprocessing section.
models/brats_mri_generative_diffusion/docs/README.md Minor adjustments in the training data description.
models/brats_mri_axial_slices_generative_diffusion/docs/README.md Minor adjustments in the training data description.
Comments suppressed due to low confidence (2)

models/vista3d/docs/README.md:97

  • Changed 'Hyperparameteers' to 'Hyperparameters' to correct the spelling error.
Hyperparameters finetuning is important and varies from task to task.

models/segmentation_template/docs/README.md:10

  • Updated 'MONAILable' to 'MONAI Label' to maintain consistency with project naming conventions.
or whatever else you want for your own new segmentation bundle. Some of the names are critical for MONAI Label but

Signed-off-by: Mingxin Zheng <[email protected]>
Copy link
Member

@ericspod ericspod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is all fine, the versions of various bundles look like they'll need updating judging from the CI error.

Signed-off-by: Mingxin Zheng <[email protected]>
@mingxin-zheng
Copy link
Contributor Author

Thanks @ericspod . Because the versioning rule in model zoo, I plan to aggregate all changes suggested by LLM in one PR, and then update the version for the models. Please feel free to revisit the PR in a later time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use of LLM-Driven Tools to Fix Documentation Error
3 participants