Skip to content
17 changes: 8 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -151,26 +151,25 @@ in Jupyter notebooks.
Sacredboard is a web-based dashboard interface to the sacred runs stored in a
MongoDB.

`Neptune <https://neptune.ml/>`_
`Neptune <https://neptune.ai/>`_
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. image:: docs/images/neptune-compare.png
.. image:: docs/images/neptune-collaboration.png

Neptune is a web service that lets you visualize, organize and compare your experiment runs.
Once things are logged to Neptune you can share it with others, add comments and even access objects via
experiment API:
Neptune is a metadata store for MLOps, built for teams that run a lot of experiments.
It gives you a single place to log, store, display, organize, compare, and query all your model-building metadata via API available for both Python and R programming languages:

.. image:: docs/images/neptune-query-api.png

In order to log your runs to Neptune, all you need to do is add an observer:
In order to log your sacred experiments to Neptune, all you need to do is add an observer:

.. code-block:: python

from neptunecontrib.monitoring.sacred import NeptuneObserver
ex.observers.append(NeptuneObserver(api_token='YOUR_API_TOKEN',
project_name='USER_NAME/PROJECT_NAME'))
from neptune.new.integrations.sacred import NeptuneObserver
ex.observers.append(NeptuneObserver(api_token='<YOUR_API_TOKEN>',
project='<YOUR_WORKSPACE/YOUR_PROJECT>'))

For more info, check the `neptune-contrib library <https://neptune-contrib.readthedocs.io/examples/observer_sacred.html>`_.
For more info, check the `Neptune + Sacred integration guide <https://docs.neptune.ai/integrations-and-supported-tools/experiment-tracking/sacred>`_.

`SacredBrowser <https://github.com/michaelwand/SacredBrowser>`_
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Expand Down
Binary file modified docs/images/neptune-collaboration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/neptune-compare.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/neptune-query-api.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 6 additions & 6 deletions docs/observers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -796,13 +796,13 @@ Note that ``/setuserpic`` requires a *minimum* picture size.

Neptune Observer
================
Neptune observer sends all the experiment metadata to the Neptune app.
It requires the `neptune-contrib <https://neptune-contrib.readthedocs.io/index.html/>`_ package to be installed.
Neptune observer sends all the experiment metadata to the Neptune UI.
It requires the `neptune-sacred <https://docs.neptune.ai/integrations-and-supported-tools/experiment-tracking/sacred>`_ package to be installed.
You can install it by running:

.. code-block:: bash

pip install neptune-contrib
pip install neptune-client neptune-sacred

Adding a Neptune Observer
-------------------------
Expand All @@ -812,9 +812,9 @@ You simply need to initialize it with your project name and (optionally) api tok

.. code-block:: python

from neptunecontrib.monitoring.sacred import NeptuneObserver
ex.observers.append(NeptuneObserver(api_token='YOUR_API_TOKEN',
project_name='USER_NAME/PROJECT_NAME'))
from neptune.new.integrations.sacred import NeptuneObserver
ex.observers.append(NeptuneObserver(api_token='<YOUR_API_TOKEN>',
project='<YOUR_WORKSPACE/YOUR_PROJECT>'))

.. warning::

Expand Down