Warning

PROJECT IS DEPRECATED You should use neptune-client instead.

neptune-lib

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')

2. 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:

• neptune-lib readthecocs
• neptune community forum
• neptune community slack (join by going here)
• Github issues

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