Skip to content

Commit

Permalink
Update CLI docs (#1180)
Browse files Browse the repository at this point in the history
  • Loading branch information
RdoubleA authored and Philip Bontrager committed Jul 16, 2024
1 parent dd3c5dc commit f071a7e
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions docs/source/tune_cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,12 +126,14 @@ The ``tune ls`` command lists out all the built-in recipes and configs within to
Copy a built-in recipe or config
--------------------------------

The ``tune cp <config> <path>`` command copies built-in recipes and configs to a provided location. This allows you to make a local copy of a library
The ``tune cp <recipe|config> <path>`` command copies built-in recipes and configs to a provided location. This allows you to make a local copy of a library
recipe or config to edit directly for yourself.

.. list-table::
:widths: 30 60

* - \-n, \--no-clobber
- Do not overwrite destination if it already exists
* - \--make-parents
- Create parent directories for destination if they do not exist. If not set to True, will error if parent directories do not exist

Expand Down Expand Up @@ -207,5 +209,6 @@ The ``tune validate <config>`` command will validate that your config is formatt

.. code-block:: bash
$ tune validate recipes/configs/full_finetune_distributed.yaml
# If you've copied over a built-in config and want to validate custom changes
$ tune validate my_configs/llama3/8B_full.yaml
Config is well-formed!

0 comments on commit f071a7e

Please sign in to comment.