Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: log policies restore exp config #10120

Merged
merged 1 commit into from
Oct 24, 2024
Merged

docs: log policies restore exp config #10120

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions docs/reference/experiment-config-reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,9 +315,21 @@ language syntax). For more information about the syntax, you can visit this `RE2

- ``action``: Optional. The action to take when the pattern is matched. Actions include:

- ``exclude_node``: Excludes a failed trial's restart attempts from being scheduled on nodes
with matching error logs.
- ``cancel_retries``: Prevents a trial from restarting if it reports a matching log.
- ``exclude_node``: Excludes a failed trial's restart attempts (due to its ``max_restarts``
policy) from being scheduled on nodes with matched error logs. This is useful for bypassing
nodes with hardware issues, such as uncorrectable GPU ECC errors.

.. note::

This option is not supported on PBS systems.

For the agent resource manager, if a trial becomes unschedulable due to enough node
exclusions, and ``launch_error`` in the master config is set to true (default), the trial will
fail.

- ``cancel_retries``: Prevents a trial from restarting if a log matches the pattern, even if the
trial has remaining max_restarts. This avoids using resources retrying a trial that encounters
failures unlikely to be resolved by retrying, such as CUDA memory issues.

Example configuration:

Expand All @@ -334,12 +346,14 @@ Example configuration:
type: cancel_retries

When a log policy matches, its name (if provided) will be displayed as a label in the WebUI,
allowing for easy identification of specific issues or events during a run.
allowing for easy identification of specific issues or events during a run. These labels will appear
in both the run table and run detail views.

These settings may also be specified at the cluster or resource pool level through task container
defaults.

To find out more about log management, visit :ref:`Log Management <log-management>`.
To find out more about log management features like **Log Search** and **Log Signal**, visit
:ref:`Log Management <log-management>`.

.. _log-retention-days:

Expand Down
Loading