総合情報サイト / マニュアル / サービス管理 / サービスの詳細と実行コードの作成(学習)

サービスの詳細と実行コードの作成(学習)

作成したサービスの内容を確認し、APIを実行するコードを作成します。

■学習サービスのAPI URLとシークレットキーの確認

サービス管理画面[学習サービス]タブのサービス一覧から、詳細を確認したいサービスを選んで詳細画面に進みます。

サービスの詳細(学習)_1.png

<学習サービスの詳細画面>

サービスの詳細(学習)_2.png
  1. API URL
    APIごとに付与される一意のURLです。
    APIを介してMatrixFlowに接続するためのURLで、外部システムに設定します。
    右端のクリップアイコンをクリックすると、クリップボードにコピーします。
    また、上図青枠の下向き矢印をクリックすると、実行する機能を[学習を実行/学習の進行状況を取得/学習を中止]から選択でき、機能に応じてURLも変わります。
  2. シークレットキー
    APIごとに付与される一意の暗号キーです。
    APIを介してMatrixFlowに接続するための認証情報で、外部システムに設定します。
    右端のクリップアイコンをクリックすると、クリップボードにコピーします。
  3. APIの各種情報
    サンプルコード、リクエスト、レスポンス(返り値)の情報です。
    実行する機能によって内容が異なります。詳細は後述をご覧ください。
  4. サービス情報
    サービスに登録されているレシピ名や前処理、予測する列、学習に使用する列が表示されます。

■APIの各種情報について

<サンプルコード>

外部システムに組み込むサンプルコードをcurlとPythonで用意しています。
下図赤枠の下向き矢印をクリックすると、curlとPythonを切り替えることができます。
また、実行する機能によってサンプルコードも切り替わります。

サンプルコードをコピー&ペーストして組み込む場合、実際の環境に合わせてRequestBodyのパラメータを変更する必要があります。詳細は後述の<RequestBody>をご覧ください。

※<RequestHeader>や<RequestBody>を参照して、ご利用環境のプログラミング言語でコーディングすることもできます。

サービスの詳細(学習)_3.png

<RequestHeader>

サービスを作成した時点で、サンプルコードには設定されています。

ヘッダー データ型 値と説明
x-matrixflow-secretkey 文字列 API作成時に発行される個々のシークレットキーの値
Content-Type 文字列 application/json

<RequestBody>

[学習を実行]時のみ指定が必要です。
次のパラメータを実際に合わせて変更します。

Windows環境のcurlで実行する場合、サンプルコード内の[post.json]のように、RequestBodyのパラメータのみを記述したjsonファイルを別に用意します。
jsonファイルは、サンプルコード内の post.json をコピー&ペーストしてテキストエディタなどで作成し、設定値のみを変更されることをお勧めします。

パラメータ   データ型 説明
data_name 文字列 学習に使用する、MatrixFlowにアップロードされているデータセット名を指定
train_config 文字列 学習時のテストデータ比率やハイパーパラメータを設定
解析手法(レシピ)により設定するパラメータが異なる。詳細後述。
SaaS上で学習を行う場合の最後のステップ「学習の詳細設定」画面の設定項目に該当
trained_ai name 文字列 学習後に保存する、学習済みAIの名前を指定(Option)
description 文字列 学習後に保存する、学習済みAIの説明を指定(Option)

■train_configに設定するパラメータ

train_config内のパラメータは、テストデータ比率とハイパーパラメータの値です。SaaS上で学習を行う場合、最後のステップ「学習の詳細設定」画面の設定項目に該当します。
サンプルコードにはデフォルト値が設定されますので、適宜変更します。

※画像データを投入する場合のみ、設定するパラメータが異なります。

▶分類(数値データ)/回帰/文書データ(分類、ベクトル化共通)/時系列解析

パラメータ   説明
data ratio テストデータ比率
デフォルト値 “0.1”

▶画像データ(分類、ベクトル化、次元圧縮共通)

パラメータ     説明
learning_rate 学習率
デフォルト値 “0.0001”
batch_size バッチサイズ
デフォルト値 “64”
epoch エポック数
デフォルト値 “5”
data ratio テストデータ比率
デフォルト値 “0.01”
saver evaluate_every train 評価間隔(学習データ)
デフォルト値 “10”
test 評価間隔(テストデータ)
デフォルト値 “30”
num_checkpoints MatrixFlow内部で使うパラメータのため変更不要

<Responses>

APIを実行し、成功した時に返される情報です。
学習サービスのレスポンスは、解析手法(レシピ)やデータの種類、実行する機能によって異なります。詳細は、APIの返り値(学習)をご覧ください。