NPQR Command Line Interface

The following commands are available on the command line of the machine running NeoPulse® Query Runtime. They can be used to manage training, querying, and inspecting results.


$ neopulse start [options]

Starts NeoPulse® Query Runtime, which consists of container services as well as worker processes running on the host OS.


  • -h, --help output usage information
  • -F, --force bypass prompt and force NeoPulse® Query Runtime to start.


$ neopulse start -F


$ neopulse status

Shows the status of the NeoPulse® Query Runtime service components: the container service and the worker processes on the main OS. Display the status of these two separate components as well as the overall status. If everything is running correctly, this should print:

info: containers up: true, worker up: true
neopulse: is running

If either component is not running the status will display:

<component> up: False


$ neopulse delete <project>

Deletes all the files associated with the given project. This operation cannot be undone; it is used to completely remove projects that are no longer needed.


$ neopulse delete Test_Project


$ neopulse logs [options] <name>

Display the logs for either the “compiler” or the “worker” service. The compiler service refers to the compiler container which is a node.js webserver on port 8081. The worker service is a process running locally on the host that performs query and training operations using the GPU. Checking the raw logs of the worker can be valuable to make sure that models start training and errors haven’t occurred.


  • -l, -lines <lines> OPTIONAL - number of tail lines of log to show.


$ neopulse logs -l 100 compiler
$ neopulse logs -l 500 worker


$ neopulse list [options] [project]

Provides functionality to display information about all training projects, a specific project, or a specific model within a project. This allows you to navigate your projects and models to easily see important information. When providing a project name or a model you can see all the metrics associated with that project, as well as any auto parameters and what values were assigned to those.


  • -m, --model <model> OPTIONAL - list information for a specific model.


neopulse list Test_Project

An example output of the above command:

neopulse: info for Test_Project currently 2/2 models completed training
MODEL           ITER    STATUS           METRICS                   CONV_1
r1fgjMHk--0     32  PRE_LOADED_MODEL val_loss,val_acc,loss,acc 64
r1fgjMHk--1     32  PRE_LOADED_MODEL val_loss,val_acc,loss,acc 128

Where the metrics that could be used for the commands “top” or “query” are listed under the column METRICS and the values of the one auto parameter for this specific project CONV_1 are displayed for both models that were created.


$ neopulse query <project> [options]

Once a model has been trained it can be queried. In general, you will probably just want to query the best performing models, so query is similar to the top command as it will list the top preforming models so you can pick one of those to query. Alternatively, you can also specify an exact model and iteration to query instead of picking from the best model/iteration for a given metric.


  • -f, --file <file> REQUIRED - path to .csv file to use as input.
  • --metric <metric> OPTIONAL - metric to sort by.
  • -n, --number <number> OPTIONAL - how many top models to show.
  • -m, --model <model> OPTIONAL - which model to use.
  • -i, --iter <iter> OPTIONAL - which training iteration to use.


$ neopulse query Test_Project -f /DM-Dash/dsl/query.csv


$ neopulse results [options]

The results command is similar to “list” for training, except it is used to show information only about queries. When a query job has been submitted a queryID is returned. This queryID will be the name of the file where the query results are saved in:



  • -q, --query <query ID> OPTIONAL - query ID to show results for.
  • -S, --show OPTIONAL - flag to print the results for the query ID.


$ neopulse results -q r1fgjMHK-0 -S


$ neopulse import [options]

Imports a project that was trained and exported with NeoPulse® AI Studio to the current machine.


  • -p, --project <project> REQUIRED - project name for imported project
  • -f, --file <file> REQUIRED file to import (a .zip file)


$ neopulse import -p Test_Project -f


$ neopulse kill [options]

Kills the container services as well as any worker processes running on the local OS. If an operation is underway in NeoPulse® Query Runtime, e.g. querying, all those results will be lost. Once kill has been called the floating license associated with this specific instance will be freed and available on the next license renewal cycle.

NOTE: License renewal occurs every hour.


  • -F, --force OPTIONAL - bypass prompt and force the NeoPulse® Query Runtime to terminate.


$ neopulse kill -F