You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
download Download a model from the Hugging Face Hub.
30
30
ls List all built-in recipes and configs
31
31
...
@@ -233,3 +233,72 @@ The ``tune validate <config>`` command will validate that your config is formatt
233
233
# If you've copied over a built-in config and want to validate custom changes
234
234
$ tune validate my_configs/llama3/8B_full.yaml
235
235
Config is well-formed!
236
+
237
+
.. _tune_cat_cli_label:
238
+
239
+
Inspect a config
240
+
---------------------
241
+
242
+
The ``tune cat <config>`` command pretty prints a configuration file, making it easy to use ``tune run`` with confidence. This command is useful for inspecting the structure and contents of a config file before running a recipe, ensuring that all parameters are correctly set.
243
+
244
+
You can also use the ``--sort`` option to print the config in sorted order, which can help in quickly locating specific keys.
245
+
246
+
.. list-table::
247
+
:widths: 30 60
248
+
249
+
* - \--sort
250
+
- Print the config in sorted order.
251
+
252
+
**Workflow Example**
253
+
254
+
1. **List all available configs:**
255
+
256
+
Use the ``tune ls`` command to list all the built-in recipes and configs within torchtune.
After inspecting the config, you can use the ``tune run`` command to run a recipe with the config. You can also override specific parameters directly from the command line. For example, to override the `output_dir` parameter:
296
+
297
+
.. code-block:: bash
298
+
299
+
$ tune run full_finetune_distributed --config llama2/7B_full output_dir=./
300
+
301
+
Learn more about config overrides :ref:`here <cli_override>`.
302
+
303
+
.. note::
304
+
You can find all the cat-able configs via the ``tune ls`` command.
0 commit comments