Contact Us
Built by ML engineers for ML engineers with ❤️
Contact

Synchronizing data with Neptune servers

How to use Neptune CLI to synchronize local 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 theneptune syncCLIcommand.

Command syntax:neptunesync[OPTIONS...][ARGUMENTS...]

Options Description
--path Path to a directory containing a.neptunefolder.
--object Object name (workspace/project/identifier or UUID for offline runs) to synchronize.
-p,--project 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.

The--runflag has been changed to--objectand is no longer available as of neptune1.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--projectflag, or by saving it to theNEPTUNE_PROJECTenvironment variable.

Examples

Synchronize all runs in the current directory:

neptune sync

Synchronize all runs in the given path:

neptune sync --path PATH_TO_DIRECTORY

Synchronize only runs SAN-42 and SAN-43 with project "jackie/sandbox":

neptune sync --object jackie/sandbox/SAN-42 --object jackie/sandbox/SAN-43

Synchronize all runs in the current directory, sending offline runs to the project "jackie/sandbox":

neptune sync -p jackie/sandbox

Synchronize only the offline runs:

neptune sync --offline-only

Synchronize only the offline runs with project "jackie/sandbox"neptunesync--projectjackie/sandbox--offline-only

neptune sync --project jackie/sandbox --offline-only

Synchronize the offline run a1561719-b425-4000-a65a-b5efb044d6bb with the project "jackie/sandbox":

neptune sync -p jackie/sandbox --object offline/a1561719-b425-4000-a65a-b5efb04d6b

Access help and examples:

neptune sync --help

neptune-notebooks incompatibility

The command doesn't work together with theNeptune-Jupyter extension(neptune-notebooks).

To use the command, you must uninstall neptune-notebooks first.

  • Set the project name
  • Connection modes reference

This page is originally sourced from the legacy docs.