.. _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-lifecycle
        :type: ref
        :text: How does Tune work?
        :classes: btn-link btn-block stretched-link

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

    .. link-button:: tune-stopping
        :type: ref
        :text: A Guide To Stopping and Resuming Tune Experiments
        :classes: btn-link btn-block stretched-link

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

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

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

    .. link-button:: tune-distributed
        :type: ref
        :text: A Guide To Distributed Hyperparameter Tuning
        :classes: btn-link btn-block stretched-link

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

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

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

    .. link-button:: tune-resources
        :type: ref
        :text: Using Resources (GPUs, Parallel & Distributed Runs)
        :classes: btn-link btn-block stretched-link

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

    .. link-button:: tune-checkpoints
        :type: ref
        :text: Using Checkpoints For Your Experiments
        :classes: btn-link btn-block stretched-link

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

    .. link-button:: tune-search-space-tutorial
        :type: ref
        :text: A Guide To Working with Advanced Search Spaces
        :classes: btn-link btn-block stretched-link

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

    .. link-button:: tune-advanced-tutorial
        :type: ref
        :text: A simple guide to Population-based Training
        :classes: btn-link btn-block stretched-link

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

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