Skip to content

Commit 88bd6b8

Browse files
authored
Update neptune + sacred integration information (#856)
* replacing neptune examples * replacing neptune collaboration example * Delete neptune-collaboration * add new neptune-collaboration image * replace neptune-query-api image * Delete neptune-query-api.png * Replace neptune-query-api image * update neptune information * text formatting * text formating * text formatting * updating neptune observer * code formatting and update * update installation code
1 parent c9266e0 commit 88bd6b8

5 files changed

Lines changed: 14 additions & 15 deletions

File tree

README.rst

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -151,26 +151,25 @@ in Jupyter notebooks.
151151
Sacredboard is a web-based dashboard interface to the sacred runs stored in a
152152
MongoDB.
153153

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

159-
Neptune is a web service that lets you visualize, organize and compare your experiment runs.
160-
Once things are logged to Neptune you can share it with others, add comments and even access objects via
161-
experiment API:
159+
Neptune is a metadata store for MLOps, built for teams that run a lot of experiments.
160+
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:
162161

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

165-
In order to log your runs to Neptune, all you need to do is add an observer:
164+
In order to log your sacred experiments to Neptune, all you need to do is add an observer:
166165

167166
.. code-block:: python
168167
169-
from neptunecontrib.monitoring.sacred import NeptuneObserver
170-
ex.observers.append(NeptuneObserver(api_token='YOUR_API_TOKEN',
171-
project_name='USER_NAME/PROJECT_NAME'))
168+
from neptune.new.integrations.sacred import NeptuneObserver
169+
ex.observers.append(NeptuneObserver(api_token='<YOUR_API_TOKEN>',
170+
project='<YOUR_WORKSPACE/YOUR_PROJECT>'))
172171
173-
For more info, check the `neptune-contrib library <https://neptune-contrib.readthedocs.io/examples/observer_sacred.html>`_.
172+
For more info, check the `Neptune + Sacred integration guide <https://docs.neptune.ai/integrations-and-supported-tools/experiment-tracking/sacred>`_.
174173

175174
`SacredBrowser <https://github.com/michaelwand/SacredBrowser>`_
176175
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1.22 MB
Loading

docs/images/neptune-compare.png

757 KB
Loading

docs/images/neptune-query-api.png

42.8 KB
Loading

docs/observers.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -796,13 +796,13 @@ Note that ``/setuserpic`` requires a *minimum* picture size.
796796

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

803803
.. code-block:: bash
804804
805-
pip install neptune-contrib
805+
pip install neptune-client neptune-sacred
806806
807807
Adding a Neptune Observer
808808
-------------------------
@@ -812,9 +812,9 @@ You simply need to initialize it with your project name and (optionally) api tok
812812

813813
.. code-block:: python
814814
815-
from neptunecontrib.monitoring.sacred import NeptuneObserver
816-
ex.observers.append(NeptuneObserver(api_token='YOUR_API_TOKEN',
817-
project_name='USER_NAME/PROJECT_NAME'))
815+
from neptune.new.integrations.sacred import NeptuneObserver
816+
ex.observers.append(NeptuneObserver(api_token='<YOUR_API_TOKEN>',
817+
project='<YOUR_WORKSPACE/YOUR_PROJECT>'))
818818
819819
.. warning::
820820

0 commit comments

Comments
 (0)