mirror of
https://github.com/vale981/ray
synced 2025-03-09 21:06:39 -04:00
5cc9355303
Continuing docs overhaul, tune now has: - [x] better landing page - [x] a getting started guide - [x] user guide was cut down, partially merged with FAQ, and partially integrated with tutorials - [x] the new user guide contains guides to tune features and practical integrations - [x] we rewrote some of the feature guides for clarity - [x] we got rid of sphinx-gallery for this sub-project (only data and core left), as it looks bad and is unnecessarily complicated anyway (plus, makes the build slower) - [x] sphinx-gallery examples are now moved to markdown notebook, as started in #22030. - [x] Examples are tested in the new framework, of course. There's still a lot one can do, but this is already getting too large. Will follow up with more fine-tuning next week. Co-authored-by: Antoni Baum <antoni.baum@protonmail.com> Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com>
37 lines
1.2 KiB
ReStructuredText
37 lines
1.2 KiB
ReStructuredText
.. _tune-wandb-ref:
|
|
|
|
Using Weights & Biases with Tune
|
|
================================
|
|
|
|
`Weights & Biases <https://www.wandb.ai/>`_ (Wandb) is a tool for experiment
|
|
tracking, model optimizaton, and dataset versioning. It is very popular
|
|
in the machine learning and data science community for its superb visualization
|
|
tools.
|
|
|
|
.. image:: /images/wandb_logo_full.png
|
|
:height: 80px
|
|
:alt: Weights & Biases
|
|
:align: center
|
|
:target: https://www.wandb.ai/
|
|
|
|
Ray Tune currently offers two lightweight integrations for Weights & Biases.
|
|
One is the :ref:`WandbLoggerCallback <tune-wandb-logger>`, which automatically logs
|
|
metrics reported to Tune to the Wandb API.
|
|
|
|
The other one is the :ref:`@wandb_mixin <tune-wandb-mixin>` decorator, which can be
|
|
used with the function API. It automatically
|
|
initializes the Wandb API with Tune's training information. You can just use the
|
|
Wandb API like you would normally do, e.g. using ``wandb.log()`` to log your training
|
|
process.
|
|
|
|
Please :doc:`see here for a full example </tune/examples/wandb_example>`.
|
|
|
|
.. _tune-wandb-logger:
|
|
|
|
.. autoclass:: ray.tune.integration.wandb.WandbLoggerCallback
|
|
:noindex:
|
|
|
|
.. _tune-wandb-mixin:
|
|
|
|
.. autofunction:: ray.tune.integration.wandb.wandb_mixin
|
|
:noindex:
|