init_neptune: Initialize 'Neptune' project

Description Usage Arguments Author(s) See Also Examples

View source: R/neptune.R

Description

It initializes a 'Neptune' project in which you can create experiments and log experiment metadata. 'Neptune' is a lightweight experiment tracking tool, for more information see <https://neptune.ai/>.

Usage

1
2
3
4
init_neptune(project_name,
            api_token = NULL,
            python = NULL,
            python_path)

Arguments

project_name

string, a name of the project in Neptune. Has a format 'USERNAME/PROJECT_NAME'

api_token

string, your Neptune API token that you can copy from your Neptune account

python

string, environemnt type. Can be one of 'python', 'conda', 'miniconda', and 'venv'

python_path

string, path to your python distribution. For exmaple if you selected python ='miniconda' you can have an example python_path = ‘/home/marry/miniconda3/bin/python’

Author(s)

Authors:

See Also

Useful links:

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
## Not run: 
# We are using api token for an anonymous user neptuner. For your projects use your private token.
init_neptune(api_token = 'ANONYMOUS',
             project_name = 'shared/r-integration')

# Start logging
create_experiment(name = 'my first experiment')
log_metric('accuracy', 0.92)

# Stop logging
stop_experiment()
# See an example experiment here https://ui.neptune.ai/o/shared/org/r-integration/e/RIN-56/logs

## End(Not run)

neptune documentation built on Jan. 13, 2021, 5:40 a.m.