[DO NOT MERGE] Create temporary files for doc review #30
Conversation
| You can adapt this file completely to your liking, but it should at least | ||
| contain the root `toctree` directive. | ||
|
|
||
| NeMo-Run documentation |
There was a problem hiding this comment.
revise title and remove "documentation." Suggest changing the title to "Get Started with NeMo-Run".
Get Started with NeMo-Run
| NeMo-Run documentation | ||
| ====================== | ||
|
|
||
| NeMo-Run is a powerful tool designed to streamline the configuration, execution and management of Machine Learning experiments across various computing environments. NeMo Run has three core responsibilities: |
There was a problem hiding this comment.
Fix punctuation and capitalization.
NeMo-Run is a powerful tool designed to streamline the configuration, execution, and management of machine learning experiments across various computing environments. NeMo-Run has three core responsibilities:
| Please click into each link to learn more. | ||
| This is also the typical order Nemo Run users will follow to setup and launch experiments. |
There was a problem hiding this comment.
revise:
Please click on each link to learn more. This sequence also represents the typical order that NeMo-Run users follow to set up and launch experiments.
| Installation | ||
| --------- |
There was a problem hiding this comment.
revise title to an imperative verb.
Install NeMo-Run
|
|
||
| ``pip install git+https://github.com/NVIDIA/NeMo-Run.git`` | ||
|
|
||
| To install Skypilot, we have optional features available. |
There was a problem hiding this comment.
revise.
To install Skypilot, we have three options available:
|
|
||
| ``pip install git+https://github.com/NVIDIA/NeMo-Run.git[skypilot]`` | ||
| will install Skypilot w Kubernetes | ||
|
|
||
| ``pip install git+https://github.com/NVIDIA/NeMo-Run.git[skypilot-all]`` | ||
| will install Skypilot w all clouds | ||
|
|
||
| You can also manually install Skypilot from https://skypilot.readthedocs.io/en/latest/getting-started/installation.html |
There was a problem hiding this comment.
revise section, add bullets, and fix punctuation.
-
To install Skypilot with Kubernetes:
pip install git+https://github.com/NVIDIA/NeMo-Run.git[skypilot] -
To install Skypilot with all clouds:
pip install git+https://github.com/NVIDIA/NeMo-Run.git[skypilot-all] -
You can also manually install Skypilot from
Read the Docs <https://skypilot.readthedocs.io/en/latest/getting-started/installation.html>_.
| Tutorials | ||
| --------- | ||
|
|
||
| The ``hello_world`` tutorial series provides a comprehensive introduction to NeMo Run, demonstrating its capabilities through a simple example. The tutorial covers: |
There was a problem hiding this comment.
fix punctuation.
The hello_world tutorial series provides a comprehensive introduction to NeMo-Run, demonstrating its capabilities through a simple example. The tutorial covers:
| 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.
change list to bullets and suggest adding tutorial names to this list.
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>_
| @@ -0,0 +1,142 @@ | |||
| # Execute NeMo Run | |||
There was a problem hiding this comment.
fix punctuation.
Execute NeMo-Run
|
|
||
| After configuring NeMo-Run, the next step is to execute it. Nemo-Run decouples configuration from execution, allowing you to configure a function or task once and then execute it across multiple environments. With Nemo-Run, you can choose to execute a single task or multiple tasks simultaneously on different remote clusters, managing them under an experiment. This brings us to the core building blocks for execution: `run.Executor` and `run.Experiment`. | ||
|
|
||
| Each execution of a single configured task requires an executor. Nemo-Run provides `run.Executor`, which are APIs to configure your remote executor and set up the packaging of your code. Currently we support: |
There was a problem hiding this comment.
fix punctuation.
Each execution of a single configured task requires an executor. Nemo-Run provides run.Executor, which are APIs to configure your remote executor and set up the packaging of your code. Currently, we support:
|
|
||
| > **_NOTE:_** git archive doesn't package uncommitted changes. In the future, we may add support for including uncommitted changes while honoring `.gitignore`. | ||
|
|
||
| ### Defining Executors |
There was a problem hiding this comment.
change title to an imperative verb.
Define Executors
| Use the SSH Tunnel when launching from your local machine, or the Local Tunnel if you’re already on the Slurm cluster. | ||
|
|
||
| #### SkypilotExecutor | ||
| This executor is used to configure [Skypilot](https://skypilot.readthedocs.io/en/latest/docs/index.html). Make sure Skypilot is installed and atleast one cloud is configured using `sky check`. |
There was a problem hiding this comment.
fix spacing.
This executor is used to configure Skypilot. Make sure Skypilot is installed and at least one cloud is configured using sky check.
No description provided.