|
| 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. |
1 | 35 |
|
2 | 36 |
|
3 | 37 | Defining parameters for custom recipes |
|
0 commit comments