Programatically access neptune experiments, run comparisons and inspect results.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
neptunelib
tests
.gitignore
.travis.yml
CODE_OF_CONDUCT.md
LICENSE
MANIFEST.in
Makefile
README.md
docs_requirements.txt
git_version.py
pylintrc
requirements.txt
setup.py
test_requirements.txt
tox.ini

README.md

neptune-lib

Build Status

Documentation

See neptune-lib documentation site

Getting started

Get api-token

neptune account api-token get

Establish session

from neptunelib.session import Session
session = Session(api_token='YOUR_NEPTUNE_API_TOKEN')

you can also create an environment variable NEPTUNE_API_TOKEN:

export NEPTUNE_API_TOKEN=YOUR_NEPTUNE_API_TOKEN`

and simpy go

from neptunelib.session import Session
session = Session()

Instatiate a Project object

project = session.get_projects('neptune-ml')['neptune-ml/Salt-Detection']

Get leaderbaord dataframe

leaderboard_df = project.get_leaderboard()

Get experiment data

experiments = project.get_experiments(id=['SAL-2342'])
experiment = experiments[0]
  1. get numeric channel values dataframe. Lets take the network_1 epoch_val iou loss channel for example (long name I know).
    channel_df = experiment.get_numeric_channels_values('network_1 epoch_val iou loss')
  1. get hardware utilization dataframe
   channel_df = experiment.get_hardware_utilization()

Installation

Get prerequisites

  • python versions 2.7/3.5/3.6 are supported
  • neptune-cli
       pip install neptune-cli

Install lib

pip install neptune-lib

Getting help

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

Contributing

If you see something that you don't like you are more than welcome to contribute! There are many options:

  • Participate in discussions on neptune community forum or neptune community slack
  • Submit a feature request or a bug here, on Github
  • Submit a pull request that deals with an open feature request or bug
  • Spread a word about neptune-lib in your community