Skip to content

Commit a0043f6

Browse files
committed
docs: update index, debugging, and guide links for new get-started structure
1 parent 94ea2bf commit a0043f6

File tree

6 files changed

+189
-169
lines changed

6 files changed

+189
-169
lines changed

docs/debugging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Since Ray programs can spawn multiple workers and actors, using the Ray Distribu
99
### Prerequisites
1010

1111
* Install the [Ray Debugger VS Code/Cursor extension](https://docs.ray.io/en/latest/ray-observability/ray-distributed-debugger.html).
12-
* Launch the [interactive cluster](./cluster.md#interactive-launching) with `ray.sub`.
12+
* Launch the [interactive cluster](get-started/cluster.md#2-submit-a-job) with `ray.sub`.
1313
* Launch VS Code/Cursor on the SLURM login node (where `squeue`/`sbatch` is available).
1414
* Add `breakpoint()` in your code under actors & tasks (i.e. classes or functions decorated with `@ray.remote`).
1515
* **Ensure** `RAY_DEBUG=legacy` is not set since this debugging requires the default distributed debugger.

docs/guides/dpo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ to increase the probability of the chosen response and decrease the probability
66

77
## Launch a DPO Run
88

9-
The script [examples/run_dpo.py](../../examples/run_dpo.py) can be used to launch a DPO experiment. This script can either be launched locally or via Slurm. For details on how to set up Ray and launch a job using Slurm, refer to the [cluster documentation](../cluster.md).
9+
The script [examples/run_dpo.py](../../examples/run_dpo.py) can be used to launch a DPO experiment. This script can either be launched locally or via Slurm. For details on how to set up Ray and launch a job using Slurm, refer to the [cluster documentation](../get-started/cluster.md).
1010

1111
Be sure to launch the job using `uv`. The command to launch a DPO job is as follows:
1212
```bash

docs/guides/grpo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This guide details the Group Relative Policy Optimization (GRPO) implementation
44

55
## Quickstart: Launch a GRPO Run
66

7-
To get started quickly, use the script [examples/run_grpo_math.py](../../examples/run_grpo_math.py), which demonstrates how to train a model on math problems using GRPO. You can launch this script locally or via Slurm. For detailed instructions on setting up Ray and launching a job with Slurm, refer to the [cluster documentation](../cluster.md).
7+
To get started quickly, use the script [examples/run_grpo_math.py](../../examples/run_grpo_math.py), which demonstrates how to train a model on math problems using GRPO. You can launch this script locally or via Slurm. For detailed instructions on setting up Ray and launching a job with Slurm, refer to the [cluster documentation](../get-started/cluster.md).
88

99
We recommend launching the job using `uv`:
1010

docs/guides/rm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This document explains how to train reward models (RM) within NeMo RL. Currently
44

55
## Launch a Training Job
66

7-
The script, [examples/run_rm.py](../../examples/run_rm.py), is used to train a Bradley-Terry reward model. This script can be launched either locally or via Slurm. For details on how to set up Ray and launch a job using Slurm, refer to the [cluster documentation](../cluster.md).
7+
The script, [examples/run_rm.py](../../examples/run_rm.py), is used to train a Bradley-Terry reward model. This script can be launched either locally or via Slurm. For details on how to set up Ray and launch a job using Slurm, refer to the [cluster documentation](../get-started/cluster.md).
88

99
Be sure to launch the job using `uv`. The command to launch a training job is as follows:
1010

docs/guides/sft.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This document explains how to perform SFT within NeMo RL. It outlines key operat
44

55
## Launch an SFT Run
66

7-
The script, [examples/run_sft.py](../../examples/run_sft.py), can be used to launch an experiment. This script can be launched either locally or via Slurm. For details on how to set up Ray and launch a job using Slurm, refer to the [cluster documentation](../cluster.md).
7+
The script, [examples/run_sft.py](../../examples/run_sft.py), can be used to launch an experiment. This script can be launched either locally or via Slurm. For details on how to set up Ray and launch a job using Slurm, refer to the [cluster documentation](../get-started/cluster.md).
88

99
Be sure to launch the job using `uv`. The command to launch an SFT job is as follows:
1010

0 commit comments

Comments
 (0)