総合情報サイト / マニュアル / サービス管理 / APIの返り値(学習)

APIの返り値(学習)

AIモデルの学習を APIで行った際のレスポンス(返り値)です。
※MatrixFlowで学習を行った後に表示される学習の結果ではありません。

■レスポンスのデータ形式

項目 値と説明
MIMEタイプ application/json
文字コード Unicode(UTF-8)

■レスポンスの値

実行する機能やデータの種類によって出力フィールドが異なります。
また、フィールドの出力順は実行環境によって異なります。

▶学習を実行

<画像データ以外の場合>

数値データの分類、回帰、時系列解析、文書データの分類、ベクトル化が該当します。

フィールド_0 フィールド_1 フィールド_2 説明
job_id MatrixFlow内部で自動付与する、学習処理の識別ID
data_name 学習に使用したデータセット名
train_config learning_rate 学習率:null
batch_size バッチサイズ:null
epoch エポック数:null
data ratio テストデータ比率
デフォルト値 “0.1”
predictionColumn 予測する列名:配列
inputColumns 学習に使用する列名:配列
  saver 評価間隔:null
edaRecipe id レシピID
accountId アカウントID

<画像データの場合>

画像データの分類、ベクトル化、次元圧縮のみ該当します。

フィールド_0 フィールド_1 フィールド_2 説明
job_id MatrixFlow内部で自動付与する、学習処理の識別ID
data_name 学習に使用したデータセット名
train_config learning_rate 学習率
デフォルト値 “0.0001”
batch_size バッチサイズ
デフォルト値 “64”
epoch エポック数
デフォルト値 “5”
data ratio テストデータ比率
デフォルト値 “0.01”
predictionColumn 予測する列名:null
inputColumns 学習に使用する列名:配列のnull
  saver evaluate_every.train 評価間隔(学習データ)
デフォルト値 “10”
evaluate_every.test 評価間隔(テストデータ)
デフォルト値 “30”
num_checkpoints システム内部で使用
固定値 “5”
edaRecipe null

▶学習の進行状況を取得

フィールド_0 説明
status 学習の進行状況(次のいずれか)
・SUBMITTED: 処理の開始
・PENDING: 学習環境を構築中
・RUNNABLE: 実行開始前
・STARTING: 学習を開始
・RUNNING: 学習中
・SUCCEEDED: 学習成功
・FAILED: 学習失敗
n_iter 学習の施行回数
cur_iter 終了した学習の回数
n_prediction_column 設定した予測する列の数
cur_prediction_column 学習が終わった予測する列の数
generated_trained_ai_id_list 保存した学習済みAIのID:配列

▶学習を中止

フィールド_0 説明
job_id 中止した学習処理の識別ID
(識別IDは学習開始時にMatrixFlow内部で自動付与される)