Command Line Interface

neptune

Neptune stores data on disk in .neptune directories. In case an object is created in the offline mode or the network becomes unavailable and Neptune switches to the offline mode, data can be synchronized with the server with this command-line utility.

Usage

neptune [OPTIONS] COMMAND [ARGS]...
Options
--help
Shows CLI usage - options, commands and their arguments

neptune status

List synchronized and unsynchronized objects (runs, models, and model versions) in the given directory. Trashed objects are not listed.
You can upload all data to the server by running neptune sync.
Options
--path <location>
A path to a directory containing a .neptune folder.
--help
Show command's usage and exits.

Examples

1
# List synchronized and unsynchronized objects in the current directory
2
neptune status
3
4
# List synchronized and unsynchronized objects in directory "foo/bar" without actually syncing
5
neptune status --path foo/bar
Copied!

neptune sync

Synchronizes objects with unsent data with the server.
You can list all unsynchronized objects by running neptune status.
Options
--path <location>
A path to a directory containing a .neptune folder.
--object <object>
Object name (workspace/project/identifier or UUID for offline runs) to synchronize
--run <run_name>
Deprecated, use --object instead.
-p, --project <project_name>
Project name (workspace/project) to which objects created in the offline mode should be added.
--offline-only
Synchronize only the offline runs.
--help
Show command's usage and exits.

Examples

1
# Synchronize all objects in the current directory
2
neptune sync
3
4
# Synchronize all objects in the given path
5
neptune sync --path foo/bar
6
7
# Synchronize only runs "NPT-42" and "NPT-43"
8
# in "workspace/project" in the current directory
9
neptune sync --object workspace/project/NPT-42 --object workspace/project/NPT-43
10
11
# Synchronise all objects in the current directory,
12
# sending offline created objects to project "workspace/project"
13
neptune sync --project workspace/project
14
15
# Synchronize only the offline runs
16
neptune sync --offline-only
17
18
# Synchronize only the offline runs with project "workspace/project"
19
neptune sync --project workspace/project --offline-only
20
21
# Synchronize only the offline run with UUID offline/a1561719-b425-4000-a65a-b5efb044d6bb
22
# to project "workspace/project"
23
neptune sync --project workspace/project --object offline/a1561719-b425-4000-a65a-b5efb044d6bb
Copied!
For objects created in offline mode, you need to specify which project the data should be uploaded to. You can either specify it through the --project parameter or by setting the NEPTUNE_PROJECT environment variable.
Export as PDF
Copy link