.. _tune-guides:

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

.. tip:: We'd love to hear your feedback on using Tune - `get in touch <https://forms.gle/PTRvGLbKRdUfuzQo9>`_!

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:`Exercises <tune-exercises>` to get started.

.. _tune-feature-guides:

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

.. panels::
    :container: container pb-4
    :column: col-md-4 px-2 py-2
    :img-top-cls: pt-5 w-50 d-block mx-auto

    ---
    :img-top: /images/tune.png

    .. link-button:: tune-run
        :type: ref
        :text: Running Basic Experiments
        :classes: btn-link btn-block stretched-link

    ---
    :img-top: /images/tune.png

    .. link-button:: tune-output
        :type: ref
        :text: Logging Tune Runs
        :classes: btn-link btn-block stretched-link

    ---
    :img-top: /images/tune.png

    .. link-button:: tune-resources
        :type: ref
        :text: Setting Trial Resources
        :classes: btn-link btn-block stretched-link

    ---
    :img-top: /images/tune.png

    .. link-button:: tune-search-space-tutorial
        :type: ref
        :text: Using Search Spaces
        :classes: btn-link btn-block stretched-link

    ---
    :img-top: /images/tune.png

    .. link-button:: tune-stopping
        :type: ref
        :text: How to Define Stopping Criteria for a Ray Tune Experiment
        :classes: btn-link btn-block stretched-link

    ---
    :img-top: /images/tune.png

    .. link-button:: tune-trial-checkpoints
        :type: ref
        :text: How to Save and Load Trial Checkpoints
        :classes: btn-link btn-block stretched-link

    ---
    :img-top: /images/tune.png

    .. link-button:: tune-storage
        :type: ref
        :text: How to Configure Storage Options for a Distributed Tune Experiment
        :classes: btn-link btn-block stretched-link

    ---
    :img-top: /images/tune.png

    .. link-button:: tune-fault-tolerance
        :type: ref
        :text: How to Enable Fault Tolerance in Ray Tune
        :classes: btn-link btn-block stretched-link

    ---
    :img-top: /images/tune.png

    .. link-button:: tune-metrics
        :type: ref
        :text: Using Callbacks and Metrics
        :classes: btn-link btn-block stretched-link

    ---
    :img-top: /images/tune.png

    .. link-button:: ../tutorials/tune_get_data_in_and_out
        :type: ref
        :text: Getting Data in and out of Tune
        :classes: btn-link btn-block stretched-link

    ---
    :img-top: /images/tune.png

    .. link-button:: ../examples/tune_analyze_results
        :type: ref
        :text: Analyzing Tune Experiment Results
        :classes: btn-link btn-block stretched-link

    ---
    :img-top: /images/tune.png

    .. link-button:: ../examples/pbt_guide
        :type: ref
        :text: A Guide to Population-Based Training
        :classes: btn-link btn-block stretched-link

    ---
    :img-top: /images/tune.png

    .. link-button:: tune-distributed
        :type: ref
        :text: Deploying Tune in the Cloud
        :classes: btn-link btn-block stretched-link

    ---
    :img-top: /images/tune.png

    .. link-button:: tune-lifecycle
        :type: ref
        :text: Tune Architecture
        :classes: btn-link btn-block stretched-link

    ---
    :img-top: /images/tune.png

    .. link-button:: tune-scalability
        :type: ref
        :text: Scalability Benchmarks
        :classes: btn-link btn-block stretched-link