https://github.com/neptune-ai/neptune-lib
Project is deprecated. Please go to neptune-client.
https://github.com/neptune-ai/neptune-lib
api api-client artificial-intelligence comparison-tool data-science deep-learning experiment extensibility extension machine-learning neptune neptune-platform python python27 python3
Last synced: about 1 year ago
JSON representation
Project is deprecated. Please go to neptune-client.
- Host: GitHub
- URL: https://github.com/neptune-ai/neptune-lib
- Owner: neptune-ai
- License: apache-2.0
- Created: 2019-01-08T13:32:15.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-07-19T15:48:43.000Z (almost 7 years ago)
- Last Synced: 2025-04-05T22:25:43.056Z (over 1 year ago)
- Topics: api, api-client, artificial-intelligence, comparison-tool, data-science, deep-learning, experiment, extensibility, extension, machine-learning, neptune, neptune-platform, python, python27, python3
- Language: Python
- Homepage: https://docs.neptune.ml
- Size: 107 KB
- Stars: 5
- Watchers: 12
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Warning
**PROJECT IS DEPRECATED**
You should use [neptune-client](https://github.com/neptune-ml/neptune-client) instead.
# neptune-lib
[](https://travis-ci.org/neptune-ml/neptune-lib)
# Documentation
See [neptune-lib documentation site](https://neptune-lib.readthedocs.io)
# Getting started
## Get api-token
```bash
neptune account api-token get
```
## Establish session
```python
from neptunelib.session import Session
session = Session(api_token='YOUR_NEPTUNE_API_TOKEN')
```
you can also create an environment variable `NEPTUNE_API_TOKEN`:
```bash
export NEPTUNE_API_TOKEN=YOUR_NEPTUNE_API_TOKEN`
```
and simpy go
```python
from neptunelib.session import Session
session = Session()
```
## Instatiate a Project object
```python
project = session.get_projects('neptune-ml')['neptune-ml/Salt-Detection']
```
## Get leaderbaord dataframe
```python
leaderboard_df = project.get_leaderboard()
```
## Get experiment data
```python
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).
```python
channel_df = experiment.get_numeric_channels_values('network_1 epoch_val iou loss')
```
2. get hardware utilization dataframe
```python
channel_df = experiment.get_hardware_utilization()
```
# Installation
## Get prerequisites
* python versions `2.7/3.5/3.6` are supported
* `neptune-cli`
```python
pip install neptune-cli
```
## Install lib
```bash
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](https://neptune-lib.readthedocs.io)
* [neptune community forum](https://community.neptune.ml/)
* [neptune community slack](https://neptune-community.slack.com) (join by going [here](https://join.slack.com/t/neptune-community/shared_invite/enQtNTI4Mjg3ODk2MjQwLWE5YjI0YThiODViNDY4MDBlNmRmZTkwNTE3YzNiMjQ5MGM2ZTFhNzhjN2YzMTIwNDM3NjQyZThmMDk1Y2Q1ZjY))
* 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](https://community.neptune.ml/) or [neptune community slack](https://neptune-community.slack.com)
* 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