Skip to content

Commit

Permalink
Update llm recipe README to add a note about handling multi-process j…
Browse files Browse the repository at this point in the history
…obs (#10649)

Signed-off-by: Hemil Desai <hemild@nvidia.com>
  • Loading branch information
hemildesai authored Sep 27, 2024
1 parent 4f59502 commit d51d8b9
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions nemo/collections/llm/recipes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,27 +16,30 @@ Recipes are designed to be modular and extensible, allowing users to easily cust

### Command Line Interface

You can use these recipes via the NeMo CLI:
You can use these recipes via the NeMo CLI (provided by [NeMo-Run](https://github.com/NVIDIA/NeMo-Run)):

```bash
nemorun llm <task> --factory <recipe_name>
nemo llm <task> --factory <recipe_name>
```
Where:
- `<task>` is either `pretrain` or `finetune`
- `<recipe_name>` is the name of the recipe (e.g. `llama3_8b`)

For example:
```bash
nemorun llm pretrain --factory llama3_8b
nemo llm pretrain --factory llama3_8b
```

> [!IMPORTANT]
> When launching the recipes with multiple processes (i.e. on multiple GPUs), add the `-y` option to the command to avoid user confirmation prompts.
> For example, `nemo llm pretrain --factory llama3_8b -y`
### Customizing Parameters

You can override any parameter in the recipe:

```bash
nemorun llm pretrain --factory llama3_8b trainer.max_steps=2000
nemo llm pretrain --factory llama3_8b trainer.max_steps=2000
```

For more details around running recipes, see [pre-train](../../../../examples/llm/pretrain/README.md).
Expand Down

0 comments on commit d51d8b9

Please sign in to comment.