# Gluon Predict

このノートブックは、*gluon_train* ノートブックで構築された予測モデルを使用して予測を行うために使用されます。

### サンプル出力

トレーニングで使用されたラベルと同じカラム名(例: y)が *input_table* に存在する場合、予測結果は *predicted* というプレフィックスを付けた *predicted_y* として出力されます。ラベルカラムが *input_table* に存在しない場合、予測結果は *y* カラムに出力されます。

*predicted_proba* および *predicted_probabilities* カラムは、二値分類または多クラス分類の結果です。二値分類の場合、*predict_proba* はポジティブクラスの確率です。ネガティブクラスの確率は 1.0 - *predict_proba* で取得できます。多クラス分類の場合、*predict_proba* は予測されたクラスの確率です。

| y | predicted_y | predicted_proba | predicted_probabilities |
|  --- | --- | --- | --- |
| yes | no | 0.29304519295692444 | {"no": 0.706954836845398, "yes": 0.29304519295692444} |
| no | no | 0.00487339636310935 | {"no": 0.9951266050338745, "yes": 0.00487339636310935} |
| ... | ... | ... | ... |
| yes | yes | 0.5266873240470886 | {"no": 0.4733126759529114, "yes": 0.5266873240470886} |


*rowid_column* が指定されている場合、*rowid* カラムに予測結果のみを追加し、結果のテーブルサイズは小さくなります。*rowid_column* には、*user_id* や *product_id* のような一意の値を想定しています。

### ワークフロー例

サンプルワークフローについては、[Treasure Boxes](https://github.com/treasure-data/treasure-boxes/blob/automl/machine-learning-box/automl/ml_experiment.dig)を参照してください。


```yaml
+gluon_predict:
  ml_predict>:
    notebook: gluon_predict
    model_name: gluon_model
    input_table: ml_datasets.bank_marketing_test
    output_table: ml_test.predicted
```

### パラメータ

| パラメータ名 | コンソール上のパラメータ | 説明 | デフォルト値 |
|  --- | --- | --- | --- |
| docker.task_mem | Docker Task Mem | タスクメモリサイズ。契約されているティアに応じて、64g、128g(デフォルト)、256g、384g、または512gの値を使用できます | 128g |
| model_name | Model Name | 予測モデル名 | - |
| input_table | Input Table | テストデータとして使用されるTDテーブル名 | - |
| output_table | Output Table | 予測結果をエクスポートするTDテーブル名 | - |
| output_mode | Output Mode | *output_table* をエクスポートする際の出力モード: overwrite、replace、または append。通常、指定する必要はなく、*rowid_filter* を使用したセミリアルタイム予測ではappendを使用します | overwrite |
| ignore_columns | Ignore Columns | 予測モデル構築時に無視するカラム | time |
| rowid_column | Rowid Column | *rowid*(主キー)カラム。*rowid_column* が指定されている場合、出力テーブルにはrowidカラムと予測結果カラムのみが表示されることに注意してください。 | None |
| rowid_filter | Rowid Filter | *rowid* カラム値による予測対象の行のフィルタリング | None |
| export_leaderboard | Export Leaderboard | 指定されている場合、リーダーボードをTDテーブルとしてエクスポートします | None |
| export_feature_importance | Export Feature Importance | 指定されている場合、特徴量の重要度をTDテーブルとしてエクスポートします | None |
| hide_table_contents | Hide Table Contents | テーブルの内容の表示を抑制します | false |
| shared_model | Shared Model | 共有モデルのUUIDを指定します | None |
| audience_name | Audience Name | 属性テーブルをマージするためのAudienceペアレント(マスター)セグメント名 | None |
| foreign_key | Foreign Key | 属性テーブルをマージするためのAudienceペアレント(マスター)テーブル内の外部キー | None |