neptune sync: Synchronizing data with Neptune servers#
If there are objects with data that have not been sent to the Neptune server, you can upload the offline data manually with the neptune sync CLI command.
Command syntax: neptune sync [OPTIONS...] [ARGUMENTS...]
| Options | Description |
|---|---|
--path <location> |
Path to a directory containing a .neptune folder. |
--object <object> |
Object name (workspace/project/identifier or UUID for offline runs) to synchronize. |
-p, --project <project-name> |
Project name (workspace-name/project-name) to which objects created in the offline mode should be added. |
--offline-only |
Synchronize only the offline runs. |
--help |
Show command usage and exits. |
Deprecated --run option
The --run flag has been changed to --object and is no longer available as of neptune 1.0.
For runs created in offline mode, you need to specify the project where the data should be uploaded. You can set the project name either it with the --project flag, or by saving it to the NEPTUNE_PROJECT environment variable.
Examples#
Synchronize all runs in the current directory:
Synchronize all runs in the given path:
Synchronize only runs SAN-42 and SAN-43 with project "jackie/sandbox":
Synchronize all runs in the current directory, sending offline runs to the project "jackie/sandbox":
Synchronize only the offline runs:
Synchronize only the offline runs with project "jackie/sandbox"
Synchronize the offline run a1561719-b425-4000-a65a-b5efb044d6bb with the project "jackie/sandbox":
Access help and examples:
neptune-notebooks incompatibility
Currently, the command does not work together with the Neptune-Jupyter extension (neptune-notebooks).
Until a fix is released, if you have neptune-notebooks installed, you must uninstall it to be able to use the neptune sync command.