.. _api-reference:

API Reference
*************

Rubicon
=======
.. autoclass:: rubicon_ml.Rubicon
   :members:
   :inherited-members:

.. _library-reference-project:

Project
=======
.. autoclass:: rubicon_ml.Project
   :members:
   :inherited-members:

.. _library-reference-experiment:

Experiment
==========
.. autoclass:: rubicon_ml.Experiment
   :members:
   :inherited-members:

.. _library-reference-parameter:

Parameter
=========
.. autoclass:: rubicon_ml.Parameter
   :members:
   :inherited-members:

.. _library-reference-feature:

Feature
=======
.. autoclass:: rubicon_ml.Feature
   :members:
   :inherited-members:

.. _library-reference-metric:

Metric
======
.. autoclass:: rubicon_ml.Metric
   :members:
   :inherited-members:

.. _library-reference-dataframe:

Dataframe
=========
.. autoclass:: rubicon_ml.Dataframe
   :members:
   :inherited-members:

.. _library-reference-artifact:

Artifact
========
.. autoclass:: rubicon_ml.Artifact
   :members:
   :inherited-members:

.. _library-reference-publish:

repositories
============
.. autoclass:: rubicon_ml.repository.LocalRepository

.. autoclass:: rubicon_ml.repository.MemoryRepository

.. autoclass:: rubicon_ml.repository.S3Repository

.. autoclass:: rubicon_ml.repository.WandBRepository

exception_handling
==================

.. autofunction:: rubicon_ml.set_failure_mode

publish (deprecated)
====================
``rubicon_ml.publish`` is deprecated and will be removed in an upcoming release.
It requires the ``intake`` optional dependency: ``pip install rubicon-ml[intake]``.

.. autofunction:: rubicon_ml.intake_rubicon.publish.publish

.. _library-reference-sklearn:

schema
======

.. automodule:: rubicon_ml.schema.logger
   :members:

.. automodule:: rubicon_ml.schema.registry
   :members:

sklearn
=======
``rubicon_ml`` offers direct integration with **Scikit-learn** via our
own pipeline object.

.. autoclass:: rubicon_ml.sklearn.RubiconPipeline
   :members:

.. autoclass:: rubicon_ml.sklearn.FilterEstimatorLogger
   :members:

.. autofunction:: rubicon_ml.sklearn.pipeline.make_pipeline

.. _library-reference-viz:

viz
===
``rubicon_ml`` offers visualization leveraging **Dash** and **Plotly**.
Each of the following classes are standalone widgets.

.. autoclass:: rubicon_ml.viz.DataframePlot
   :members: serve, show

.. autoclass:: rubicon_ml.viz.ExperimentsTable
   :members: serve, show

.. autoclass:: rubicon_ml.viz.MetricCorrelationPlot
   :members: serve, show

.. autoclass:: rubicon_ml.viz.MetricListsComparison
   :members: serve, show

Widgets can be combined into an interactive dashboard.

.. autoclass:: rubicon_ml.viz.Dashboard
   :members: serve, show