Skip to content

Fix typo and missing description of content in folder #2004

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

Merged
merged 1 commit into from
Jun 24, 2025

Conversation

mingxin-zheng
Copy link
Contributor

@mingxin-zheng mingxin-zheng commented Jun 24, 2025

Fixes #2001 .

Description

These fixes are suggested by Cursor + claude-4-sonnet, with a prompt:

Please review the documentation (markdown/jupyter) in the tutorial repo  for clarity, with a focus of typo fixes and language refinement

Checks

  • Avoid including large-size files in the PR.
  • Clean up long text outputs from code cells in the notebook.
  • For security purposes, please check the contents and remove any sensitive info such as user names and private key.
  • Ensure (1) hyperlinks and markdown anchors are working (2) use relative paths for tutorial repo files (3) put figure and graphs in the ./figure folder
  • Notebook runs automatically ./runner.sh -t <path to .ipynb file>

Signed-off-by: Mingxin Zheng <mingxinz@nvidia.com>
Copy link
Contributor

@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 PR cleans up typos and refines the README documentation across several tutorial folders, and adds a missing overview section for the 3D regression tutorial.

  • Standardizes phrasing (e.g., "In summary," capitalization, spelling corrections).
  • Improves clarity by adding a Tutorial Overview and run instructions in the 3D regression README.
  • Fixes minor spelling errors and redundant wording in existing READMEs.

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file
File Description
vista_3d/README.md Lowercased "In summary," and added "a" before model.
vista_2d/README.md Lowercased "In summary,".
pathology/tumor_detection/README.MD Corrected "compare to" → "compared to".
nnunet/README.md Removed redundant clause, fixed "diretory" spelling; improved "singlular" → "singular".
acceleration/distributed_training/distributed_training.md Rephrased multi-node training example for consistency.
README.md Fixed "dictionary-base" → "dictionary-based".
3d_regression/README.md Added descriptive overview and run instructions with Colab badge.

@ericspod ericspod merged commit 8b90a16 into main Jun 24, 2025
6 checks passed
@ericspod ericspod deleted the cursor/doc_fix_3 branch June 24, 2025 15:19
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 Errors
2 participants