Command Line Interface (CLI)

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.

Configure

Lets the user configure some of the settings of NeoPulse® application.

neopulse configure [options]

Options

OPTIONS ALIAS INPUT TYPE DESCRIPTION
--server_port Number Port on which the NeoPulse® server should run
--gui_port Number Port on which the NeoPulse® GUI should run
--visualize_port Number Port on which the project training visualize should run
--db_port Number Port on which the NeoPulse® Database should run
--queue_port Number Port on which the NeoPulse® Queue should run

Examples

neopulse configure --server_port 23456

Delete

Deletes a project or query. The CLI will prompt whether to delete a project or a query, and then prompt for the project name or query id, respectively.

neopulse delete

Import

Import a pim file that was exported from a compatible NeoPulse® Query Runtime variant.

neopulse import [options]

Options

OPTIONS ALIAS INPUT TYPE DESCRIPTION
--project -p String Name of the project that is being imported
--file -f String Absolute path to the NeoPulse® PIM file

Examples

neopulse import -p my_project -f /absolute/path/to/my_export.pim

List

Displays information about a specific project, or a specific model. If no project is provided, it displays information about all projects.

neopulse list [project_name] [options]

Arguments

ARGUMENT INPUT TYPE DESCRIPTION
[project_name] String Name of the project. When provided its model information is listed.

Options

OPTIONS ALIAS INPUT TYPE DESCRIPTION
--model -m String Name of the model whose information is requested.
--all -a Boolean flag when supplied the details of model auto parameters is also shown. This has to be sent along with a project name or model ID

NOTE: All boolean flags must be supplied at the end of the command. See example for correct usage.

Examples

neopulse list my_project
neopulse list -m my_project_1 -a

Logs

Display the logs for either the “server” or the “neopulse” service. The neopulse service performs training and query operations. Checking the raw logs of the neopulse service can be valuable to make sure that models start training and errors haven’t occurred.

neopulse logs <module_name> [options]

Arguments

ARGUMENT INPUT TYPE DESCRIPTION
<module_name> String Name of the log module that is to be retrieved

Options

OPTIONS ALIAS INPUT TYPE DESCRIPTION
--lines -l Number The number of last lines of log to show

NOTE: "server" module logs are the logs that record the job workflow and its stages. "neopulse" module logs are the logs that record the logs of the training or querying process.

Examples

neopulse logs server -l 100
neopulse logs neopulse -l 500

Query

Queries an iteration of a model with input provided as a CSV file.

neopulse query <project_name> [options]

Arguments

ARGUMENT INPUT TYPE DESCRIPTION
<project_name> String Name of the project

Options

OPTIONS ALIAS INPUT TYPE DESCRIPTION
--model -m String Model ID that is to be queried
--iter -i Number Iteration number that is to be queried
--file -f String Absolute path to input csv file for querying the iteration of a model

Examples

neopulse query my_project -f /absolute/path/to/query.csv

Results

Displays information on the submitted query job.

neopulse results <query_id> [options]

Arguments

ARGUMENT INPUT TYPE DESCRIPTION
<query_id> String Query ID that was returned when the query job was submitted

Options

OPTIONS ALIAS INPUT TYPE DESCRIPTION
--show -S Boolean flag when supplied prints the results of the query job with the

NOTE: All boolean flags must be supplied at the end of the command. See example for correct usage.

Examples

neopulse results r1fgjMHK-0 -S

Shutdown

Shutdown NeoPulse® application. If an operation is underway in NeoPulse® Query Runtime, e.g. training or querying, all those results will be lost.

neopulse shutdown [options]

Options

OPTIONS ALIAS INPUT TYPE DESCRIPTION
--force -F Boolean flag that force NeoPulse® Query Runtime to shutdown

NOTE: All boolean flags must be supplied at the end of the command. See example for correct usage.

Examples

neopulse shutdown -F

Start

Starts NeoPulse® Query Runtime.

neopulse start [options]

Options

OPTIONS ALIAS INPUT TYPE DESCRIPTION
--force -F Boolean flag that force NeoPulse® Query Runtime to start by fixing any broken state of application

NOTE: All boolean flags must be supplied at the end of the command. See example for correct usage.

Examples

neopulse start -F

Status

Shows the status of NeoPulse® Query Runtime. Use this to check if NeoPulse® is running on the machine.

neopulse status

Visualize

Starts Tensorboard graphical visualization of project training which can be viewed in browser. This visualization tool is visible on port 46925 by default of the localhost.

neopulse visualize <project_name>

Arguments

ARGUMENT INPUT TYPE DESCRIPTION
<project_name> String Name of the project that is to be visualized

NOTE: Project must be an existing project that training has at least started on.

Examples

neopulse visualize my_project