fix docs tutorial links and add intro to guides/index.md#285
Merged
Conversation
Signed-off-by: Hemil Desai <hemild@nvidia.com>
Signed-off-by: Andrew Schilling <aschilling@nvidia.com>
aschilling-nv
previously approved these changes
Jul 9, 2025
jgerh
reviewed
Jul 9, 2025
jgerh
left a comment
jgerh
left a comment
There was a problem hiding this comment.
Completed tech pubs review and provided a few copyedits and suggested revisions to headings and text.
| If you're new to NeMo-Run, we recommend starting with: | ||
|
|
||
| - **[Why Use NeMo-Run?](why-use-nemo-run.md)** - Understand the benefits and philosophy behind NeMo-Run | ||
| - **[Configuration](configuration.md)** - Learn how to configure your ML tasks and experiments |
There was a problem hiding this comment.
Suggested change
| - **[Configuration](configuration.md)** - Learn how to configure your ML tasks and experiments | |
| - **[Configuration](configuration.md)** - Learn how to configure your ML tasks and experiments. |
|
|
||
| - **[Why Use NeMo-Run?](why-use-nemo-run.md)** - Understand the benefits and philosophy behind NeMo-Run | ||
| - **[Configuration](configuration.md)** - Learn how to configure your ML tasks and experiments | ||
| - **[Execution](execution.md)** - Discover how to run your experiments across different computing environments |
There was a problem hiding this comment.
Suggested change
| - **[Execution](execution.md)** - Discover how to run your experiments across different computing environments | |
| - **[Execution](execution.md)** - Discover how to run your experiments across different computing environments. |
| - **[Why Use NeMo-Run?](why-use-nemo-run.md)** - Understand the benefits and philosophy behind NeMo-Run | ||
| - **[Configuration](configuration.md)** - Learn how to configure your ML tasks and experiments | ||
| - **[Execution](execution.md)** - Discover how to run your experiments across different computing environments | ||
| - **[Management](management.md)** - Master experiment tracking, reproducibility, and organization |
There was a problem hiding this comment.
Suggested change
| - **[Management](management.md)** - Master experiment tracking, reproducibility, and organization | |
| - **[Management](management.md)** - Master experiment tracking, reproducibility, and organization. |
|
|
||
| NeMo-Run is built around three core responsibilities: | ||
|
|
||
| 1. **Configuration** - Define your ML experiments using a flexible, pythonic configuration system |
There was a problem hiding this comment.
Suggested change
| 1. **Configuration** - Define your ML experiments using a flexible, pythonic configuration system | |
| 1. **Configuration** - Define your ML experiments using a flexible, Pythonic configuration system. |
| NeMo-Run is built around three core responsibilities: | ||
|
|
||
| 1. **Configuration** - Define your ML experiments using a flexible, pythonic configuration system | ||
| 2. **Execution** - Run your experiments seamlessly across local machines, Slurm clusters, cloud providers, and more |
There was a problem hiding this comment.
Suggested change
| 2. **Execution** - Run your experiments seamlessly across local machines, Slurm clusters, cloud providers, and more | |
| 2. **Execution** - Run your experiments seamlessly across local machines, Slurm clusters, cloud providers, and more. |
| ``` | ||
|
|
||
| ## **Canceling a Task** | ||
| ## Canceling a Task |
There was a problem hiding this comment.
Suggested change
| ## Canceling a Task | |
| ## Cancel a Task |
| ``` | ||
|
|
||
| ## **Viewing Logs** | ||
| ## Viewing Logs |
There was a problem hiding this comment.
Suggested change
| ## Viewing Logs | |
| ## View Logs |
| ``` | ||
|
|
||
| ## **Experiment output** | ||
| ## Experiment output |
There was a problem hiding this comment.
Suggested change
| ## Experiment output | |
| ## Review Experiment Output |
| guides/index | ||
| API Reference <api/nemo_run/index> | ||
| faqs | ||
|
|
There was a problem hiding this comment.
Line 6, capitalize title
NeMo-Run Documentation
Line 25 revise heading
Install the Project
Line 31 to 37 suggested revision
To install Skypilot with optional features, use one of the following commands:
-
To install Skypilot with Kubernetes support:
pip install git+https://github.com/NVIDIA-NeMo/Run.git[skypilot] -
To install Skypilot with support for all cloud platforms:
pip install git+https://github.com/NVIDIA-NeMo/Run.git[skypilot-all]
Line 53 use NeMo-Run to be consistent
The hello_world tutorial series provides a comprehensive introduction to NeMo-Run, demonstrating its capabilities through a simple example. The tutorial covers:
Comment on lines
+62
to
+64
| 1. `Part 1 <../../../examples/hello-world/hello_world.ipynb>`_ | ||
| 2. `Part 2 <../../../examples/hello-world/hello_experiments.ipynb>`_ | ||
| 3. `Part 3 <../../../examples/hello-world/hello_scripts.py>`_ |
There was a problem hiding this comment.
suggest adding the name of the experiments to the link. For example:
Part 1 Hello World <../../../examples/hello-world/hello_world.ipynb>_Part 2 Hello Experiments <../../../examples/hello-world/hello_experiments.ipynb>_Part 3 Hello Scripts <../../../examples/hello-world/hello_scripts.py>_
aschilling-nv
approved these changes
Jul 15, 2025
zoeyz101
pushed a commit
to zoeyz101/NeMo-Run
that referenced
this pull request
Nov 12, 2025
…#285) * fix docs tutorial links and add intro to guides/index.md Signed-off-by: Hemil Desai <hemild@nvidia.com> * Adding project.json/versions1.json, and update conf.py Signed-off-by: Andrew Schilling <aschilling@nvidia.com> * fixes Signed-off-by: Hemil Desai <hemild@nvidia.com> --------- Signed-off-by: Hemil Desai <hemild@nvidia.com> Signed-off-by: Andrew Schilling <aschilling@nvidia.com> Co-authored-by: Andrew Schilling <aschilling@nvidia.com> Signed-off-by: Zoey Zhang <zozhang@nvidia.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.