ray/doc/source/tune/tutorials/tune-comet.rst
Max Pumperla 5cc9355303
[Docs ] Tune docs overhaul (first part) (#22112)
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>
2022-02-07 15:47:03 +00:00

24 lines
758 B
ReStructuredText

.. _tune-comet-ref:
Using Comet with Tune
================================
`Comet <https://www.comet.ml/site/>`_ is a tool to manage and optimize the
entire ML lifecycle, from experiment tracking, model optimization and dataset
versioning to model production monitoring.
.. image:: /images/comet_logo_full.png
:height: 80px
:alt: Comet
:align: center
:target: https://www.comet.ml/site/
Ray Tune offers an integration with Comet through the :ref:`CometLoggerCallback <tune-comet-logger>`, which automatically logs
metrics and parameters reported to Tune to the Comet UI.
Please :doc:`see here for a full example </tune/examples/comet_example>`.
.. _tune-comet-logger:
.. autoclass:: ray.tune.integration.comet.CometLoggerCallback
:noindex: