.. _tune-guides:

===========
User Guides
===========

.. toctree::
    :hidden:

    Running Basic Experiments <tune-run>
    tune-output
    Setting Trial Resources <tune-resources>
    Using Search Spaces <tune-search-spaces>
    tune-stopping
    tune-trial-checkpoints
    tune-storage
    tune-fault-tolerance
    Using Callbacks and Metrics <tune-metrics>
    tune_get_data_in_and_out
    ../examples/tune_analyze_results
    ../examples/pbt_guide
    Deploying Tune in the Cloud <tune-distributed>
    Tune Architecture <tune-lifecycle>
    Scalability Benchmarks <tune-scalability>


In this section, you can find material on how to use Tune and its various features.
You can follow our :ref:`Tune Feature Guides <tune-feature-guides>`, but can also  look into our
:ref:`Practical Examples <tune-recipes>`, or go through some :ref:`tune-examples-exercises` to get started.

.. _tune-feature-guides:

Tune Feature Guides
-------------------


.. grid:: 1 2 3 4
    :gutter: 1
    :class-container: container pb-3

    .. grid-item-card::
        :img-top: /images/tune.png
        :class-img-top: pt-2 w-75 d-block mx-auto fixed-height-img

        .. button-ref:: tune-run

            Running Basic Experiments

    .. grid-item-card::
        :img-top: /images/tune.png
        :class-img-top: pt-2 w-75 d-block mx-auto fixed-height-img

        .. button-ref:: tune-output

            Logging Tune Runs

    .. grid-item-card::
        :img-top: /images/tune.png
        :class-img-top: pt-2 w-75 d-block mx-auto fixed-height-img

        .. button-ref:: tune-resources

            Setting Trial Resources

    .. grid-item-card::
        :img-top: /images/tune.png
        :class-img-top: pt-2 w-75 d-block mx-auto fixed-height-img

        .. button-ref:: tune-search-space-tutorial

            Using Search Spaces

    .. grid-item-card::
        :img-top: /images/tune.png
        :class-img-top: pt-2 w-75 d-block mx-auto fixed-height-img

        .. button-ref:: tune-stopping

            How to Define Stopping Criteria for a Ray Tune Experiment

    .. grid-item-card::
        :img-top: /images/tune.png
        :class-img-top: pt-2 w-75 d-block mx-auto fixed-height-img

        .. button-ref:: tune-trial-checkpoints

            How to Save and Load Trial Checkpoints

    .. grid-item-card::
        :img-top: /images/tune.png
        :class-img-top: pt-2 w-75 d-block mx-auto fixed-height-img

        .. button-ref:: tune-storage

            How to Configure Storage Options for a Distributed Tune Experiment

    .. grid-item-card::
        :img-top: /images/tune.png
        :class-img-top: pt-2 w-75 d-block mx-auto fixed-height-img

        .. button-ref:: tune-fault-tolerance

            How to Enable Fault Tolerance in Ray Tune

    .. grid-item-card::
        :img-top: /images/tune.png
        :class-img-top: pt-2 w-75 d-block mx-auto fixed-height-img

        .. button-ref:: tune-metrics

            Using Callbacks and Metrics

    .. grid-item-card::
        :img-top: /images/tune.png
        :class-img-top: pt-2 w-75 d-block mx-auto fixed-height-img

        .. button-ref:: ../tutorials/tune_get_data_in_and_out

            Getting Data in and out of Tune

    .. grid-item-card::
        :img-top: /images/tune.png
        :class-img-top: pt-2 w-75 d-block mx-auto fixed-height-img

        .. button-ref:: tune-analysis-guide

            Analyzing Tune Experiment Results

    .. grid-item-card::
        :img-top: /images/tune.png
        :class-img-top: pt-2 w-75 d-block mx-auto fixed-height-img

        .. button-ref:: ../examples/pbt_guide

            A Guide to Population-Based Training

    .. grid-item-card::
        :img-top: /images/tune.png
        :class-img-top: pt-2 w-75 d-block mx-auto fixed-height-img

        .. button-ref:: tune-distributed

            Deploying Tune in the Cloud

    .. grid-item-card::
        :img-top: /images/tune.png
        :class-img-top: pt-2 w-75 d-block mx-auto fixed-height-img

        .. button-ref:: tune-lifecycle

            Tune Architecture

    .. grid-item-card::
        :img-top: /images/tune.png
        :class-img-top: pt-2 w-75 d-block mx-auto fixed-height-img

        .. button-ref:: tune-scalability

            Scalability Benchmarks