Skip to content

Commit

Permalink
update config tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
kartikayk committed Mar 20, 2024
1 parent e14b440 commit dd30097
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/source/examples/configs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down

0 comments on commit dd30097

Please sign in to comment.