Skip to content
Neptune client library - integrate your Python scripts with Neptune
Python Makefile
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cli
docs Docstrings (#136) Jul 18, 2019
neptune Add `fileno` method to streams wrappers (#155) Aug 20, 2019
tests Allow client to send log values without X-coordinate (#147) Aug 20, 2019
.gitattributes Versioning using versioneer Apr 18, 2019
.gitignore Separate execution context from experiment (#63) Mar 14, 2019
.readthedocs.yml
.travis.yml Run tests on Python 3.7 Apr 23, 2019
CODE_OF_CONDUCT.md Initialize repository Feb 11, 2019
LICENSE Initial commit Feb 11, 2019
MANIFEST.in Versioning using versioneer Apr 18, 2019
Makefile Move stderr and stdout channels to system namespace (#96) May 10, 2019
README.md Update README.md (#150) Aug 14, 2019
docs_requirements.txt Update docs_requirements.txt Jun 14, 2019
pylintrc Add a ping thread to notify if the experiment is responding (#8) Feb 14, 2019
requirements.txt Set minimal version of oauthlib (#86) Apr 15, 2019
setup.cfg
setup.py Versioning using versioneer Apr 18, 2019
test_requirements.txt Run tests on Python 3.7 Apr 23, 2019
tox.ini Initialize repository Feb 11, 2019
versioneer.py

README.md

neptune-client

Downloads Downloads Downloads

PyPI version Build Status

Overview

Neptune is an experiment tracking hub that brings organization and collaboration to your data science team.

It works with any:

  • infrastructure setup
  • framework
  • working style

Keep the knowledge in one place, organized and ready to be shared with anyone.

image image image image

Getting started

Register

Go to https://neptune.ml/ and sign up.

It is completely free for individuals and non-organizations, and you can invite others to join your team!

Get your API token

In order to start working with Neptune you need to get the API token first. To do that, click on the Get API Token button on the top left.

image

Create your first project

Click on Projects and the New project. Choose a name for it and whether you want it public or private.

image

Invite others

Go to your project, click Settings and send invites!

image

Start tracking your work

Neptune let's you track any information important to your experimentation process.

Install Neptune client

Just run:

pip install neptune-client

Initialize Neptune

Toward the top of your script insert the following snippet.

import neptune

neptune.init(api_token='YOUR_API_TOKEN',
             project_qualified_name='USERNAME/PROJECT_NAME')

Create and stop the experiment

You can treat every piece of work that you want to record as an experiment. Just create an experiment:

neptune.create_experiment()

Do whatever you want and record it here! Stop the experiment.

neptune.stop()

Track hyperparameters

Making sure that all your hyperparameters are recorded is very important. With Neptune, you can do that easily by passing params dictionary when creating the experiment.

params = {'n_estimators':10,
          'criterion': 'gini',
          'max_depth': 2,
          'min_samples_split': 100}

neptune.create_experiment(params=params)

Track metrics

It is super easy. Just log your metric to Neptune.

neptune.send_metric('roc_auc', 0.82)

In case you want to track your metric after every step (deep learning), you can simply send your metric to the same channel after every step and Neptune will automatically create a chart for you.

for i in range(100):
     neptune.send_metric('learning_rate_schedule', 0.01 *1.05 ** i) 

Track result diagnostics

You can even log images to Neptune. Just save to the

plot_roc(y_test, y_test_pred)
plt.savefig('roc_curve.png') 
neptune.send_image('roc_curve', 'roc_curve.png')

Track artifacts

You can save model weights and any other artifact that you created during your experiment.

from sklearn.externals import joblib
joblib.dump(clf, 'rf_model.pkl')
neptune.send_artifact('rf_model.pkl')

Track data versions

from hashlib import sha1

data_version = sha1(X).hexdigest()
neptune.send_text('data_version', data_version)

Track code

You can track your codebase too. Just choose the files that you want to send to Neptune.

neptune.create_experiment(upload_source_files=['utils.py', 
                                               'main.py'])

Check the example project here

Getting help

If you get stuck, don't worry we are here to help. The best order of communication is:

You can’t perform that action at this time.