Skip to content

Commit f6dba73

Browse files
committed
fix docs tutorial links and add intro to guides/index.md
Signed-off-by: Hemil Desai <hemild@nvidia.com>
1 parent 143b17c commit f6dba73

File tree

4 files changed

+52
-23
lines changed

4 files changed

+52
-23
lines changed

docs/source/guides/index.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
Guides
2+
=================
3+
4+
```{toctree}
5+
:maxdepth: 2
6+
7+
why-use-nemo-run
8+
configuration
9+
execution
10+
management
11+
ray
12+
cli
13+
```
14+
15+
Welcome to the NeMo-Run guides! This section provides comprehensive documentation on how to use NeMo-Run effectively for your machine learning experiments.
16+
17+
## Getting Started
18+
19+
If you're new to NeMo-Run, we recommend starting with:
20+
21+
- **[Why Use NeMo-Run?](why-use-nemo-run.md)** - Understand the benefits and philosophy behind NeMo-Run
22+
- **[Configuration](configuration.md)** - Learn how to configure your ML tasks and experiments
23+
- **[Execution](execution.md)** - Discover how to run your experiments across different computing environments
24+
- **[Management](management.md)** - Master experiment tracking, reproducibility, and organization
25+
26+
## Advanced Topics
27+
28+
For more advanced usage:
29+
30+
- **[Ray Integration](ray.md)** - Learn how to use NeMo-Run with Ray for distributed computing
31+
- **[CLI Reference](cli.md)** - Explore the command-line interface for NeMo-Run
32+
33+
## Core Concepts
34+
35+
NeMo-Run is built around three core responsibilities:
36+
37+
1. **Configuration** - Define your ML experiments using a flexible, pythonic configuration system
38+
2. **Execution** - Run your experiments seamlessly across local machines, Slurm clusters, cloud providers, and more
39+
3. **Management** - Track, reproduce, and organize your experiments with built-in experiment management
40+
41+
Each guide dives deep into these concepts with practical examples and best practices. Choose a guide above to get started!

docs/source/guides/index.rst

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/source/guides/management.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Management
1+
# Manage NeMo-Run
22

33
The central component for management of tasks in NeMo-Run is the `Experiment` class. It allows you to define, launch, and manage complex workflows consisting of multiple tasks. This guide provides an overview of the `Experiment` class, its methods, and how to use it effectively.
44

5-
## **Creating an Experiment**
5+
## Creating an Experiment
66

77
To create an experiment, you can instantiate the `Experiment` class by passing in a descriptive title:
88

@@ -14,7 +14,7 @@ When executed, it will automatically generate a unique experiment ID for you, wh
1414

1515
> [!NOTE] > `Experiment` is a context manager and `Experiment.add` and `Experiment.run` methods can currently only be used after entering the context manager.
1616
17-
## **Adding Tasks**
17+
## Adding Tasks
1818

1919
You can add tasks to an experiment using the `add` method. This method supports tasks of the following kind:
2020

@@ -50,7 +50,7 @@ with run.Experiment("dag-experiment", log_level="INFO") as exp:
5050
)
5151
```
5252

53-
## **Launching an Experiment**
53+
## Launching an Experiment
5454

5555
Once you have added all tasks to an experiment, you can launch it using the `run` method. This method takes several optional arguments, including `detach`, `sequential`, and `tail_logs` and `direct`:
5656

@@ -65,7 +65,7 @@ with exp:
6565
exp.run(detach=True, sequential=False, tail_logs=True, direct=False)
6666
```
6767

68-
## **Experiment Status**
68+
## Experiment Status
6969

7070
You can check the status of an experiment using the `status` method:
7171

@@ -97,23 +97,23 @@ Task 2: simple.add.add_object
9797
- Local Directory: /home/your_user/.nemo_run/experiments/experiment_with_scripts/experiment_with_scripts_1730761155/simple.add.add_object
9898
```
9999

100-
## **Canceling a Task**
100+
## Canceling a Task
101101

102102
You can cancel a task using the `cancel` method:
103103

104104
```python
105105
exp.cancel("task_id")
106106
```
107107

108-
## **Viewing Logs**
108+
## Viewing Logs
109109

110110
You can view the logs of a task using the `logs` method:
111111

112112
```python
113113
exp.logs("task_id")
114114
```
115115

116-
## **Experiment output**
116+
## Experiment output
117117

118118
Once an experiment is run, NeMo-Run displays information on ways to inspect and reproduce past experiments. This allows you to check logs, sync artifacts (in the future), cancel running tasks, and rerun an old experiment.
119119

docs/source/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,6 @@ The ``hello_world`` tutorial series provides a comprehensive introduction to NeM
5959

6060
You can find the tutorial series below:
6161

62-
1. `Part 1 <../../../NeMo-Run/examples/hello-world/hello_world.ipynb>`
63-
2. `Part 2 <../../../NeMo-Run/examples/hello-world/hello_experiments.ipynb>`
64-
3. `Part 3 <../../../NeMo-Run/examples/hello-world/hello_scripts.py>`
62+
1. `Part 1 <../../../examples/hello-world/hello_world.ipynb>`_
63+
2. `Part 2 <../../../examples/hello-world/hello_experiments.ipynb>`_
64+
3. `Part 3 <../../../examples/hello-world/hello_scripts.py>`_

0 commit comments

Comments
 (0)