Command Line Interface (CLI)

次のコマンドは、NeoPulse® AI Studio を実行しているマシンのコマンドラインで使用できます。トレーニング、クエリ、および結果の検査をするために使用できます。

Configure

NeoPulse®アプリの設定を行います。

neopulse configure [options]

Options

OPTIONS ALIAS INPUT TYPE DESCRIPTION
--server_port Number NeoPulse®サーバが実行されるポート
--gui_port Number NeoPulse® GUIが実行されるポート
--visualize_port Number プロジェクトトレーニングのビジュアライザーのポート
--db_port Number NeoPulse® Database が実行されるポート
--queue_port Number NeoPulse® Queueが実行されるポート

Examples

neopulse configure --server_port 23456

Delete

プロジェクトまたはクエリを削除する。CLIはプロジェクトかクエリのいずれかの削除を求め、次にプレジェクトの名前かクエリのIDを求めます。

neopulse delete

Export

指定されたトレーニングが完了したプロジェクトのモデルをPIMファイルとしてエキスポートします。

neopulse export <project_name> [options]

Arguments

ARGUMENT INPUT TYPE DESCRIPTION
<project_name> String プロジェクト名

Options

OPTIONS ALIAS INPUT TYPE DESCRIPTION
--path -p String モデルのエキスポート先の絶対パス
--file -f String エキスポートするファイル名
--model -m String エキスポートするモデルのID
--iter -i Number エキスポートするモデルのイタレーション

注意: Pathのオプションが明記されている場合、そのパスにファイルがないことを確認してください。またそのユーザーがそのディレクトリに書き込む権限があることが必要です。

Examples

neopulse export my_project -p /absolute/path/to/output/directory -f my_export -m my_project_1 -i 5

Import

NeoPulse® AI Studioに互換のPIMファイルをインポートします。

neopulse import [options]

Options

OPTIONS ALIAS INPUT TYPE DESCRIPTION
--project -p String インポートするプロジェクト名
--file -f String NeoPulse® PIM ファイルへの絶対パス

Examples

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

List

指定されたプロジェクトまたはモデルの情報を表示する。プロジェクト名が明記されていない場合は、全てのプロジェクトの情報が表示されます。

neopulse list [project_name] [options]

Arguments

ARGUMENT INPUT TYPE DESCRIPTION
[project_name] String プロジェクト名:モデルの情報がリストされます。

Options

OPTIONS ALIAS INPUT TYPE DESCRIPTION
--model -m String リクエストとされたモデルの情報
--all -a モデルの自動パラメータの詳細を指定した場合のブールフラグも表示されます。これは、プロジェクト名またはモデル ID と共に送信する必要があります。

注意: すべてのブールフラグは、コマンドの最後に指定する必要があります。正しい使用法については、例を参照してください。

Examples

neopulse list my_project
neopulse list -m my_project_1 -a

Logs

「サーバー」または「neopulse」サービスのログを表示します。neopulseサービスは、トレーニングとクエリ操作を実行します。ネオパルスサービスの生のログを確認することは、モデルがトレーニングを開始し、エラーが発生していないことを確認するために役立ちます。

neopulse logs <module_name> [options]

Arguments

ARGUMENT INPUT TYPE DESCRIPTION
<module_name> String 取得するログ モジュールの名前

Options

OPTIONS ALIAS INPUT TYPE DESCRIPTION
--lines -l Number 表示するログの最後の行数

*注意: "server" モジュール ログは、ジョブ ワークフローとそのステージを記録するログです。neopulseモジュールログは、トレーニングまたはクエリプロセスのログを記録するログです。

Examples

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

Query

CSV ファイルとして提供される入力を使用して、モデルのイテレーションをクエリします。

neopulse query <project_name> [options]

Arguments

ARGUMENT INPUT TYPE DESCRIPTION
<project_name> String プロジェクト名

Options

OPTIONS ALIAS INPUT TYPE DESCRIPTION
--model -m String クエリされるモデルのID
--iter -i Number クエリするイテレーション番号
--file -f String モデルのイテレーションをクエリするための入力 csv ファイルへの絶対パス

Examples

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

Results

送信されたクエリ ジョブに関する情報を表示します。

neopulse results <query_id> [options]

Arguments

ARGUMENT INPUT TYPE DESCRIPTION
<query_id> String クエリ ジョブが送信されたときに返されたクエリ ID

Options

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

注意: すべてのブールフラグは、コマンドの最後に指定する必要があります。正しい使用法については、例を参照してください。

Examples

neopulse results r1fgjMHK-0 -S

Shutdown

NeoPulse® AI Studioをシャットダウンします。NeoPulse® AI Studio でトレーニングやクエリなどが進行中の場合これらの結果はすべて破棄われます。

neopulse shutdown [options]

Options

OPTIONS ALIAS INPUT TYPE DESCRIPTION
--force -F NeoPulse® AI Studio 強制的にシャットダウンするブールフラグ

注意: すべてのブールフラグをコマンドの最後に指定する必要があります。正しい使用法については、例を参照してください。

Examples

neopulse shutdown -F

Start

NeoPulse® AI Studioを開始する

neopulse start [options]

Options

OPTIONS ALIAS INPUT TYPE DESCRIPTION
--force -F NeoPulse® AI Studio にアプリケーションの壊れた部分を修正して開始させるブールフラグ

注意: すべてのブールフラグをコマンドの最後に指定する必要があります。正しい使用法については、例を参照してください。

Examples

neopulse start -F

Status

NeoPulse® AI Studioのステータスを表示します。NeoPulse®がマシン上で実行されているかどうかを確認します。

neopulse status

Stop

モデルがトレーニング中またはトレーニングを待機している場合、プロジェクトのすべてのモデルを停止します。

neopulse stop <project_name>

Arguments

ARGUMENT INPUT TYPE DESCRIPTION
<project_name> String 停止するプロジェクト名

Examples

neopulse stop my_project

Top

特定されたプロジェクトに指定されたメトリックに基づいて、上位モデルの N 個を表示します。

neopulse top <project_name> [options]

Arguments

ARGUMENT INPUT TYPE DESCRIPTION
<project_name> String 上位モデルを一覧表示するプロジェクトの名前

Options

OPTIONS ALIAS INPUT TYPE DESCRIPTION
--metric String [必須] 上位モデルが識別されるメトリック
--number -n Number [デフォルト: 3] 要求する上位の結果の数

Examples

neopulse top my_project --metric val_acc -n 5

Train

プロジェクトのトレーニング モデルのトレーニング ジョブを送信する。プロジェクトが正常に送信されると、トレーニング対象のモデルのモデル ID が生成され、返されます。

neopulse train [Options]

Options

OPTIONS ALIAS INPUT TYPE DESCRIPTION
--project -p String 作成されるプロジェクト名 (ユニークな名前である必要がある)
--nmlPath -f String NML ファイルへの絶対パス

注意: プロジェクトをトレーニングする場合、関連するすべてのトレーニング データがNML スクリプトに関連付けられた同じディレクトリまたはそのサブディレクトリに編成している必要があります。NML ファイルおよび CSV ファイル内のパス名は、NML スクリプトが存在するディレクトリに対する相対パスである必要があります。

Examples

neopulse train -p my_project -f /absolute/path/to/file.nml

Trim

指定されたモデルまたはパスされたモデル以外、プロジェクト内のすべてのモデルを削除します。プロジェクトがトレーニングを完了しているか、停止している必要があります。

プロジェクトのトレーニングが完了したら、最良の結果を出さなかったモデルとイテレーションを削除する必要があります。これはトレーニングによってルート ドライブに大きなモデルが生成される可能性があるからです。NeoPulse® AI Studioは、"/"のディスクスペースがなくなるとクラッシュします。ですからプロジェクトのトレーニング後にトリミングすることをお勧めします。

neopulse trim <project_name> [options]

Arguments

ARGUMENT INPUT TYPE DESCRIPTION
<project_name> String トリムするプロジェクトの名前

Options

OPTIONS ALIAS INPUT TYPE DESCRIPTION
--model -m String 保存するプロジェクトのモデル ID
--iter -i Number 保存するトレーニング済みモデルのイテレーション

Examples

neopulse trim my_project -m my_project_1 -i 5

Visualize

プロジェクトトレーニングをTensorboardブラウザでビジュアル化します。このビジュアルツールは、デフォルトでローカルホストのポート 46925 に表示されます。

neopulse visualize <project_name>

Arguments

ARGUMENT INPUT TYPE DESCRIPTION
<project_name> String ビジュアル化するプロジェクトの名前

注意: プロジェクトは、少なくともトレーニングを開始した既存のプロジェクトである必要があります。

Examples

neopulse visualize my_project