ML.NET CLI コマンド リファレンス

classification、regression、recommendation コマンドは、ML.NET CLI ツールによって提供されるメイン コマンドです。 このコマンドを使用すると、自動機械学習 (AutoML) を使用する分類、回帰、推奨モデル用の高品質の ML.NET モデルと、そのモデルを実行またはスコア付けする C# のコード例を生成できます。 さらに、そのモデルをトレーニングするための C# コードも生成され、そのモデルのアルゴリズムと設定を調べることができます。

Note

この記事は、現在プレビュー段階の ML.NET CLI と ML.NET AutoML について述べており、内容が変更される場合があります。

概要

使用例:

mlnet regression --dataset "cars.csv" --label-col price

mlnet ML タスク コマンド (classification、regression、recommendation および forecasting) では、次の資産が生成されます。

• すぐに使用できるシリアル化されたモデル .zip ("最適なモデル")。
• その生成されたモデルを実行/スコア付けする C# コード。
• そのモデルの生成に使用されるトレーニング コードを含む C# コード。

最初の 2 つの資産は、モデルを使用して予測を行うために、エンド ユーザー アプリ (ASP.NET Core Web アプリ、サービス、デスクトップ アプリなど) で直接使用できます。

3 つ目の資産のトレーニング コードは、生成されたモデルをトレーニングするために CLI によって使用された ML.NET API コードを示しています。このため、そのモデルの特定のアルゴリズムと設定を調べることができます。

使用例

分類問題に適した最も簡単な CLI コマンド (AutoML では、指定されたデータからほとんどの構成が推測されます):

mlnet classification --dataset "customer-feedback.tsv" --label-col Sentiment

回帰問題に適したもう 1 つの簡単な CLI コマンド:

mlnet regression --dataset "cars.csv" --label-col Price

トレーニング データセット、テスト データセット、その他のカスタマイズの明示的な引数を使用して、分類モデルを作成し、トレーニングします。

mlnet classification --dataset "/MyDataSets/Population-Training.csv" --test-dataset "/MyDataSets/Population-Test.csv" --label-col "InsuranceRisk" --cache on --train-time 600

コマンド オプション

mlnet ML タスク コマンド (classification、regression、recommendation、forecasting および train) では、指定したデータセットと ML.NET CLI オプションに基づいて複数のモデルがトレーニングされます。 これらのコマンドから、最適なモデルの選択、シリアル化された .zip ファイルとしてのモデルの保存、スコア付けとトレーニングを行うための C# の関連コードの生成を行うこともできます。

分類オプション

mlnet classification を実行すると、分類モデルがトレーニングされます。 ML モデルでデータを 2 つ以上のクラスに分類する場合 (例: 感情分析) は、このコマンドを選択します。

mlnet classification

--dataset <path> (REQUIRED)

--label-col <col> (REQUIRED)

--cache <option>

--has-header (Default: true)

--ignore-cols <cols>

--log-file-path <path>

--name <name>

-o, --output <path>

--test-dataset <path>

--train-time <time> (Default: 30 minutes, in seconds)

--validation-dataset <path>

-v, --verbosity <v>

-?, -h, --help

回帰オプション

mlnet regression を実行すると、回帰モデルがトレーニングされます。 ML モデルで数値を予測する場合 (例: 価格予測) は、このコマンドを選択します。

mlnet regression

--dataset <path> (REQUIRED)

--label-col <col> (REQUIRED)

--cache <option>

--has-header (Default: true)

--ignore-cols <cols>

--log-file-path <path>

--name <name>

-o, --output <path>

--test-dataset <path>

--train-time <time> (Default: 30 minutes, in seconds)

--validation-dataset <path>

-v, --verbosity <v>

-?, -h, --help

推奨オプション

mlnet recommendation を実行すると、推奨モデルがトレーニングされます。 ML モデルで評価に基づいてユーザーに項目を推奨する場合 (例: 製品推奨) は、このコマンドを選択します。

mlnet recommendation

--dataset <path> (REQUIRED)

--item-col <col> (REQUIRED)

--rating-col <col> (REQUIRED)

--user-col <col> (REQUIRED)

--cache <option>

--has-header (Default: true)

--log-file-path <path>

--name <name>

-o, --output <path>

--test-dataset <path>

--train-time <time> (Default: 30 minutes, in seconds)

--validation-dataset <path>

-v, --verbosity <v>

-?, -h, --help

無効な入力オプションを指定すると、CLI ツールによって、有効な入力の一覧とエラー メッセージが生成されます。

予測オプション

mlnet forecasting を実行すると、時系列予測モデルがトレーニングされます。 ML モデルに、履歴データ (売上予測など) に基づいて値を予測させるには、このコマンドを選択します。

mlnet forecasting

--dataset <dataset> (REQUIRED)

--horizon <horizon> (REQUIRED)

--label-col <label-col> (REQUIRED)

--time-col <time-col> (REQUIRED)

--cache <Auto|Off|On>

--has-header

--log-file-path <log-file-path>

--name <name>

-o, --output <output>

--test-dataset <test-dataset>

--train-time <train-time>

-v, --verbosity <verbosity>

トレーニング オプション

mlnet train を実行すると、Model Builder から生成された "mbconfig" ファイルに基づいてモデルがトレーニングされます。 このコマンドが機能するには、トレーニング データは "mbconfig" ファイルと同じディレクトリにある必要があります。

-training-config <training-config> (REQUIRED)

--log-file-path <log-file-path>

-v, --verbosity <verbosity>

データセット

--dataset | -d (文字列)

この引数には、次のオプションのいずれかのファイルパスを指定します。

• A:データセット ファイル全体: このオプションを使用し、ユーザーが --test-dataset と --validation-dataset を指定していない場合は、モデルの検証にクロス検証 (k 分割など) または自動データ分割アプローチが内部的に使用されます。 その場合、ユーザーはデータセットのファイルパスを入力するだけで済みます。

• B:トレーニング データセット ファイル: ユーザーがモデル検証用のデータセットも指定している場合 (--test-dataset と、必要に応じて --validation-dataset を使用)、--dataset 引数は "トレーニング データセット" のみがあることを意味します。 たとえば、80% - 20% のアプローチを使用してモデルの品質を検証し、正確度のメトリックを取得する場合、"トレーニング データセット" には 80% のデータが含まれ、"テスト データセット" には 20% のデータが含まれます。

テスト データセット

--test-dataset | -t (文字列)

テスト データセット ファイルを指すファイル パス。たとえば、正確度のメトリックを取得するために定期的な検証を行うときに 80% - 20% のアプローチを使用する場合です。

--test-dataset を使用する場合は --dataset も必要です。

--validation-dataset が使用されていない限り、--test-dataset 引数は省略可能です。 その場合、ユーザーは 3 つの引数を使用する必要があります。

検証データセット

--validation-dataset | -v (文字列)

検証データセット ファイルを指すファイル パス。 どのような場合でも、検証データセットは省略可能です。

validation dataset を使用している場合、動作は次のようになります。

• test-dataset と --dataset の引数も必須です。

• validation-dataset データセットは、モデル選択の予測誤差を推定するために使用されます。

• test-dataset は、最終的に選択されたモデルの一般化誤差の評価に使用されます。 テスト セットを "コンテナー" に保管し、データ分析の最後にのみ取り出すのが理想的です。

基本的に、validation dataset と test dataset を使用する場合、検証フェーズは 2 つの部分に分けられます。

1. 1 つ目の部分では、モデルを見て、検証データを使用して最適なパフォーマンスのアプローチを選択します (= 検証)。
2. 次に、選択したアプローチの正確度を見積もります (= テスト)。

そのため、データの分離は 80/10/10 または 75/15/10 になります。 次に例を示します。

• training-dataset ファイルには 75% のデータがあります。
• validation-dataset ファイルには 15% のデータがあります。
• test-dataset ファイルには 10% のデータがあります。

いずれの場合でも、これらのパーセンテージは、既に分割されているファイルを指定する CLI の使用ユーザーが決定します。

ラベル列

--label-col (整数または文字列)

この引数を使用すると、データセットのヘッダーに設定されている列の名前またはデータセットのファイル内の列の数値インデックスを使用して、特定の目的またはターゲット列 (予測する変数) を指定できます (列インデックス値は 0 から始まります)。

この引数は、"分類" および "回帰" の問題に使用されます。

アイテム列

--item-col (整数または文字列)

アイテム列には、ユーザーによって評価されるアイテムの一覧が含まれます (ユーザーにはアイテムをお勧めします)。 データセットのヘッダーに設定されている列の名前またはデータセットのファイル内の列の数値インデックスを使用して、この列を指定できます (列インデックス値は 0 から始まります)。

この引数は、"推奨" タスクにのみ使用されます。

評価列

--rating-col (整数または文字列)

評価列には、ユーザーによってアイテムに指定された評価の一覧が含まれます。 データセットのヘッダーに設定されている列の名前またはデータセットのファイル内の列の数値インデックスを使用して、この列を指定できます (列インデックス値は 0 から始まります)。

この引数は、"推奨" タスクにのみ使用されます。

ユーザー列

--user-col (整数または文字列)

ユーザー列には、アイテムに評価を指定するユーザーの一覧が含まれます。 データセットのヘッダーに設定されている列の名前またはデータセットのファイル内の列の数値インデックスを使用して、この列を指定できます (列インデックス値は 0 から始まります)。

この引数は、"推奨" タスクにのみ使用されます。

列を無視

--ignore-columns (文字列)

この引数を使用すると、トレーニング プロセスで読み込まれたり使用されたりしないように、データセット ファイル内の既存の列を無視することができます。

無視する列名を指定します。 複数の列名を区切るには、", " (コンマとスペース) または " " (スペース) を使用します。 空白を含む列名には引用符を使用することができます (例: "logged in")。

例:

--ignore-columns email, address, id, logged_in

ヘッダーの有無

--has-header (ブール値)

データセット ファイルにヘッダー行があるかどうかを指定します。 指定できる値は次のとおりです。

• true
• false

この引数がユーザーによって指定されていない場合、ML.NET CLI ではこのプロパティの検出が試行されます。

トレーニング時間

--train-time (文字列)

既定では、探索またはトレーニングの最長時間は 30 分です。

この引数では、プロセスで複数のトレーナーと構成を探索できる最長時間 (秒単位) を設定します。 指定した時間が 1 回の反復処理に対して短すぎる (たとえば 2 秒) 場合、構成された時間を超えることがあります。 この場合、実際の時間は、1 回の反復処理で 1 つのモデル構成を作成するために必要な時間です。

反復処理に必要な時間は、データセットのサイズによって変わります。

キャッシュ

--cache (文字列)

キャッシングを使用すると、トレーニング データセット全体がメモリ内に読み込まれます。

中小規模のデータセットでは、キャッシュを使用するとトレーニングのパフォーマンスが大幅に向上します。つまり、キャッシュを使用しない場合よりもトレーニング時間が短くなる可能性があります。

ただし、大規模なデータセットの場合、メモリ内のすべてのデータを読み込むと、メモリ不足になる可能性があるので、悪影響が出る可能性があります。 大規模なデータセット ファイルを使用してトレーニングし、キャッシュを使用しない場合、ML.NET では、トレーニング中により多くのデータを読み込む必要があるときに、ドライブから大量のデータがストリーミングされます。

次の値を指定できます。

on:トレーニング時にキャッシュを強制的に使用します。 off:トレーニング時にキャッシュを使用しないように強制します。 auto:AutoML のヒューリスティックに応じて、キャッシュを使用するかどうかが決まります。 通常、auto を選択した場合、中小規模のデータセットではキャッシュが使用され、大規模なデータセットではキャッシュが使用されません。

--cache パラメーターを指定しない場合、既定でキャッシュの auto 構成が使用されます。

名前

--name (文字列)

作成される出力プロジェクトまたはソリューションの名前。 名前が指定されていない場合は、名前 sample-{mltask} が使用されます。

ML.NET モデル ファイル (.ZIP ファイル) も同じ名前になります。

出力パス

--output | -o (文字列)

生成された出力を配置するルートの場所/フォルダー。 既定値は、現在のディレクトリです。

詳細度

--verbosity | -v (文字列)

標準出力の詳細レベルを設定します。

次の値を指定できます。

• q[uiet]
• m[inimal] (既定値)
• diag[nostic] (ログ情報レベル)

既定で CLI ツールには、作業時に最小限のフィードバック (minimal) が表示されます。たとえば、作業中かどうか、可能であれば残り時間、または完了した時間の割合などが示されます。

ヘルプ

-h |--help

各コマンドのパラメーターの説明と共に、コマンドのヘルプを出力します。

関連項目

• ML.NET CLI ツールのインストール方法
• ML.NET CLI の概要
• チュートリアル: ML.NET CLI を使用してセンチメントを分析する
• ML.NET CLI のテレメトリ