Table of Contents
Neptune CLI works on Mac OS X, GNU/Linux and Windows. Additional software is required to be installed on the operating system:
Note: If you are using Python 2.7, use
pip instead of
pip3 in commands below.
Neptune can be installed with
pip package manager:
sudo pip3 install https://s3-us-west-2.amazonaws.com/deepsense.neptune/client-library/python/1.5.1/neptune-1.5.1.tar.gz
NOTE: If you are using virtual environment solution like
then you can run this command without a
pip3 install https://s3-us-west-2.amazonaws.com/deepsense.neptune/client-library/python/1.5.1/neptune-1.5.1.tar.gz
Neptune CLI uses a configuration file or environment variables to establish a connection with Neptune Server.
The configuration file should be located in
~/.neptune.yaml on Unix systems and
%USERPROFILE%\.neptune.yaml on Windows systems.
Create this file with the following content:
host: YOUR_NEPTUNE_SERVER_HOST port: 443 username: YOUR_USERNAME password: YOUR_PASSWORD
HINT: You received
during joining the Early Adopters Program.
You can override the configuration specified in the
.neptune.yaml file with environment variables.
The variables should be exported in the terminal where Neptune CLI will be used.
export NEPTUNE_HOST=YOUR_NEPTUNE_SERVER_HOST export NEPTUNE_PORT=443 export NEPTUNE_USER=YOUR_USERNAME export NEPTUNE_PASSWORD=YOUR_PASSWORD
set NEPTUNE_HOST=YOUR_NEPTUNE_SERVER_HOST set NEPTUNE_PORT=443 set NEPTUNE_USER=YOUR_USERNAME set NEPTUNE_PASSWORD=YOUR_PASSWORD
You can set exported variables for every new session. The way of doing that is system-dependent.
Paste the snippet listed in the previous paragraph to
via System Settings in the Control Panel.
To check if you installed the correct version of Neptune CLI, run:
$ neptune -v
It should print:
1.5.1 (API: 1.5.1)
To check if you can establish connection with Neptune, run:
$ neptune ls
You should receive all jobs registered within your Neptune instance.
CLI + Python Client Library: https://s3-us-west-2.amazonaws.com/deepsense.neptune/client-library/python/1.5.1/neptune-1.5.1.tar.gz
Python Client Library is bundled together with CLI. Please follow the instruction for CLI to install Python Client Library.
To check if you installed Python Client Library correctly, start a Python interpreter:
$ python >>> from deepsense import neptune
This import should not cause any errors.
NOTE: You have to install the Java JDK version compatible with your R version (either 32- or 64-bit).
To install the required rJava package on Mac OS X or Linux, you need to have Java JDK 8 integrated with R.
To integrate the Java JDK with R, run the following commands:
$ export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:<path to your Java JDK installation>/jre/lib/amd64:<path to your Java JDK installation>/jre/lib/amd64/server" $ sudo sh -c 'export JDK_HOME=<path to your Java JDK installation>; export JAVA_HOME=$JDK_HOME/jre; R CMD javareconf'
Then you can install rJava and Neptune R Client Library:
$ R > install.packages("rJava", type = "source") > install.packages("https://s3-us-west-2.amazonaws.com/deepsense.neptune/client-library/r/1.5.0/neptune-1.5.0.tar.gz", repos = NULL, type = "source")
Install rJava and Neptune R Client library:
$ R > install.packages("rJava") > install.packages("https://s3-us-west-2.amazonaws.com/deepsense.neptune/client-library/r/1.5.0/neptune-1.5.0.tar.gz", repos = NULL, type = "source")
If installation of rJava fails, you may need to unset the
JAVA_HOME environment variable in
the R console:
> if (Sys.getenv("JAVA_HOME") != "") Sys.setenv(JAVA_HOME="")
and repeat the installation procedure.
This is a known issue of the rJava library on 64-bit Windows.
To check if you installed the R Client Library correctly, start the R interpreter and load the library. You should see a message shown below.
$ R > library(neptune) Loading required package: rJava Warning message: In fun(libname, pkgname) : No arguments to initialize Neptune Context. This library should not be used outside Neptune jobs. > packageVersion("neptune")  ‘1.5.0’
The warning message was printed because you loaded the R Client Library outside a Neptune job. To use Neptune with your R code, you need to run the code as a Neptune job using CLI.
Java Client Library is available in Maven Central Repository: https://mvnrepository.com/artifact/io.deepsense.neptune/neptune-client-library/1.5.0
--dump-dir-urlparameters replaced with a single
nameproperty from metric.
Connection to Neptune Server (...) failedmay appear despite correct Neptune configuration. The problem is related with the issue: https://github.com/kennethreitz/requests/issues/3189. We recommend to upgrade Python to at least 2.7.12.
JAVA_HOMEenvironment variable must be unset before installing rJava required by the R Client Library. This is a known issue discussed here: http://stackoverflow.com/questions/7019912/using-the-rjava-package-on-win7-64-bit-with-r/15998358#15998358.