From dd30097b8a6851b65b07c169a74a56430c9f2afe Mon Sep 17 00:00:00 2001 From: Kartikay Khandelwal Date: Wed, 20 Mar 2024 11:28:32 -0700 Subject: [PATCH] update config tutorial --- docs/source/examples/configs.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/source/examples/configs.rst b/docs/source/examples/configs.rst index 5f277c5e6e..dbf6bb715f 100644 --- a/docs/source/examples/configs.rst +++ b/docs/source/examples/configs.rst @@ -151,6 +151,17 @@ will automatically resolve it for you. _component_: torchtune.utils.metric_logging.DiskLogger log_dir: ${output_dir} +Validating your config +^^^^^^^^^^^^^^^^^^^^^^ +We provide a convenient CLI utility, :code:`tune validate`, to quickly verify that +your config is well-formed and all components can be instantiated properly. You +can also pass in overrides if you want to test out the exact commands you will run +your experiments with. If any parameters are not well-formed, :code:`tune validate` +will list out all the locations where an error was found. + +.. code-block:: bash + + tune validate --config recipes/configs/alpaca_llama2_full_finetune_single_device.yaml batch_size=4 Best practices for writing configs ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^