総合情報サイト / マニュアル / サービス管理 / APIの返り値について(回帰)

推論APIの返り値について(回帰)

回帰予測AIを推論サービスで実行した際に得られる値について解説します。

APIの返り値について(回帰)_1.jpg

外部アプリケーションやプログラムからMatrixFlowの推論サービスを実行する方法はいろいろありますが、Windows標準機能のコマンドプロンプトを利用して回帰AIの推論を行うと、上のような出力がされます。
サービス機能を使った推論を行う手順については「サービスを使って推論を行う」をご覧ください。

この出力値は[推論サービスの詳細画面]の[Responses]タブに指定されている内容に沿っており、学習や予測に使うアルゴリズムによって出力される項目が異なります。
なお、項目の出力は順不同です。
※Responsesの内容は変更できません。

返り値のフォーマットは次の通りです。

形式 :JSON
MIMEタイプ :application/json
文字コード :unicode(UTF-8)
APIの返り値について(回帰)_2.jpg

実際にはすべての値は改行されずに出力されますが、ここでは分かりやすくするため
改行して図示します。

APIの返り値について(回帰)_3.jpg

1. “action”: “finishInferring”,
  推論の終了を意味します。

2. “inferenceType”: “推論の形式”,
  予測するデータがcsvファイルの場合、”classficationStructuredData”です。

3. “id”: “推論のID”,
  MatrixFlow内部で自動で付与する実行時の識別IDです。

4. “inputColumns”: [“学習に使用した列”],
  AIを作成する際に「学習に使用した列名」をカンマ区切りで出力します。
  ※全角文字の場合、Unicodeで出力されます。(以降同様)

5. “predictionColumn”: “予測する列”,
  AIを作成する際に指定した「予測する列名」を出力します。

6. “classes”: [“予測する列のクラス”],
  データを複数のクラス(グループ)に分類するときの各グループを示す値を
  カンマ区切りで出力します。
  そのため、回帰分析では出力されません。

7. “probability”: true / false,
  次項8.で各クラスの信頼度(”クラス名_probability”)が算出されるかを出力します。
  信頼度とは「〇と△のデータがある場合、どれだけ〇のデータらしいか」を示す情報で、
  そのデータが〇のクラスに属する確率を表します。
  回帰分析では信頼度は使いませんので、常にfalseです。

APIの返り値について(回帰)_4.jpg

8. “list”: 推論データセットの行ごとに次の情報が出力されます。
  ”列名”: 入力した値,
     カンマ区切りで列数分(列が3列あれば、3列分の列名とその値)を出力します。
     MatrixFlowで推論を行ったときの、推論結果画面の右側に該当します。
     推論結果画面は[学習に使用した列]と[その値]のみですが、
     ここには投入したすべての列を出力します。

  ”予測する列名”: 予測結果,
     予測した結果を出力します。
     行ごとの推論結果詳細画面の上部、[推論結果]に該当します。

  ”クラス名_probability”: 各クラスの信頼度,
     予測結果がそのクラスにどれだけ当てはまるかを表し、
     1.0に近いほど当てはまりが良いことを意味します。
     推論結果詳細画面の[信頼度詳細]に該当します。
     回帰分析では使わない指標ですので、出力はありません。

  ”列名_importance”: 列の重要度,
     後述する 10. “shap_values” の小数第四位を四捨五入した値です。
     推論結果詳細画面の[推論結果に与えた影響度]に該当します。

APIの返り値について(回帰)_5.jpg

9. “total”: 予測した行数,
  推論データセットの行数です。

10. “feature_importance”: {“shap_values”: [[行ごとの学習に使用した列の重要度]]},
  shap_valuesは、各行の予測値が学習に使用したそれぞれの列からどのくらい影響を受けているか
  を表します。影響度なのでマイナス値もあり得ます。
  8. listの “列名_importance” と重複しますが、投入したすべての行の四捨五入する前の値を
  カンマ区切りで出力します。
  AIモデルが列の値をどう使って予測をしたのか、列の値は予測結果にどのくらい影響を与えている
  のかなど、予測結果の解釈に用います。

考え方例)住宅価格の中央値を予測します

⇒「平均部屋数」と「低所得者の割合」の絶対値が他と比較して大きく、
かつマイナス値のため推論結果の価格を下げる方向に大きく寄与したと説明できます。

APIの返り値について(回帰)_7.png
APIの返り値について(回帰)_6.jpg

11. “x_test”: [[行ごとの学習に使用した列の重要度の分布]],
  推論に使用した列の値を行ごとにカンマ区切りで出力します。

12. “input_columns”: [“学習に使用した列名”],
  学習に使用した列名をカンマ区切りですべて出力します。

13. “mean_shap”: {“列名”: 推論結果全体における列の重要度},
  推論結果全体に対する学習に使用した列の重要度をカンマ区切りで出力します。
  推論結果画面の右上[重要度を表示]で確認できる値に該当します。

※全角文字の文字コードはUnicodeです。