diff --git a/docs/source/reference/config.rst b/docs/source/reference/config.rst index bd64c7c051b..7f24c59063f 100644 --- a/docs/source/reference/config.rst +++ b/docs/source/reference/config.rst @@ -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 ` for more details. + Spec: ``~/.sky/config.yaml`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/source/reference/yaml-spec.rst b/docs/source/reference/yaml-spec.rst index 1e56240989c..35e56726ad4 100644 --- a/docs/source/reference/yaml-spec.rst +++ b/docs/source/reference/yaml-spec.rst @@ -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: ...