Skip to content

Commit

Permalink
[Docs] Add docs for the task level config (#3746)
Browse files Browse the repository at this point in the history
* [Docs] Add docs for the task level config

* Add tip box
  • Loading branch information
Michaelvll authored Jul 12, 2024
1 parent efe4625 commit bce117d
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/source/reference/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ You can pass **optional configurations** to SkyPilot in the ``~/.sky/config.yaml

Such configurations apply to all new clusters and do not affect existing clusters.

.. tip::

Some config fields can be overridden on a per-task basis through the :code:`experimental.config_overrides` field. See :ref:`here <task-yaml-experimental>` for more details.

Spec: ``~/.sky/config.yaml``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
31 changes: 31 additions & 0 deletions docs/source/reference/yaml-spec.rst
Original file line number Diff line number Diff line change
Expand Up @@ -331,3 +331,34 @@ Available fields:
# Demoing env var usage.
echo Env var MODEL_SIZE has value: ${MODEL_SIZE}
.. _task-yaml-experimental:

Experimental
------------

.. note::

Experimental features and APIs may be changed or removed without any notice.

In additional to the above fields, SkyPilot also supports the following experimental fields in the task YAML:

.. code-block:: yaml
experimental:
# Override the configs in ~/.sky/config.yaml from a task level.
#
# The following fields can be overridden. Please refer to docs of Advanced
# Configuration for more details of those fields:
# https://skypilot.readthedocs.io/en/latest/reference/config.html
config_overrides:
docker:
run_options: ...
kubernetes:
pod_config: ...
provision_timeout: ...
gcp:
managed_instance_group: ...
nvidia_gpus:
disable_ecc: ...

0 comments on commit bce117d

Please sign in to comment.