Skip to content

Commit 1cf100a

Browse files
committed
update configs tutorial
1 parent 2b5a3b4 commit 1cf100a

File tree

3 files changed

+35
-20
lines changed

3 files changed

+35
-20
lines changed

docs/source/examples/configs.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,37 @@
1+
=================
2+
Configs Deep-Dive
3+
=================
4+
5+
This tutorial will guide you through writing configs for running recipes and
6+
designing params for custom recipes.
7+
8+
.. grid:: 2
9+
10+
.. grid-item-card:: :octicon:`mortar-board;1em;` What you will learn
11+
12+
* How to write a YAML config and run a recipe with it
13+
* How to create a params dataclass for custom recipe
14+
* How to effectively use configs, CLI overrides, and dataclasses for running recipes
15+
16+
.. grid-item-card:: :octicon:`list-unordered;1em;` Prerequisites
17+
18+
* Be familiar with the :ref:`overview of TorchTune<overview_label>`
19+
* Make sure to :ref:`install TorchTune<install_label>`
20+
* Understand the :ref:`fundamentals of recipes<recipe_deepdive>``
21+
22+
23+
Where parameters are sourced
24+
----------------------------
25+
26+
There are two primary entry points for users to configure parameters: configs and
27+
CLI overrides. Configs are YAML files that define all the parameters that the user
28+
wishes to run a recipe with in a single location. These can be overridden on the
29+
command-line for quick changes and experimentation without modifying the config.
30+
31+
If you are planning to make your own custom recipe, you will need to become familiar
32+
with the recipe dataclass, which collects all the user arguments from config and
33+
CLI and passes it into the recipe itself. Here, we will discuss all three concepts:
34+
configs, CLI, and dataclasses.
135

236

337
Defining parameters for custom recipes

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,6 @@ TorchTune tutorials.
8282
:caption: Recipes
8383
:hidden:
8484

85-
recipes/how_to_run
8685
recipes/finetune_llm
8786
recipes/alpaca_generate
8887

@@ -94,6 +93,7 @@ TorchTune tutorials.
9493

9594
examples/recipe_deepdive
9695
examples/first_finetune_tutorial
96+
examples/configs
9797

9898
.. toctree::
9999
:glob:

docs/source/recipes/how_to_run.rst

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

0 commit comments

Comments
 (0)