予測用モデルの学習（Prophet）
前提条件
学習 API を利用するためには、Business プランを契約した上でモデル API サービス 無制限オプションに加入している必要があります。
モデル API サービス 無制限オプションの詳細については以下を参照してください。
事前準備
Prophetの学習 API を利用するには、以下の条件を満たしている必要があります。
- 実験管理 に学習 API で利用したい予測用ツリーの実行時のパラメータが表示されていること
- 上記予測用ツリーのモデルとして Prophet が利用されていること
手順
Node-AI 上での準備
学習 API を利用するためには以下の2つを Node-AI で準備する必要があります。
- API キー (JWT)
- 学習用モデルID (UUID)
Node-AI の API タブ に進んでいただき、「API用モデルを作成」ボタンを押してください。
■APIが作成されていない場合
■すでにAPIが作成されている場合
次のようなモーダルが表示されるので、利用したいモデルを選び、「次へ」をクリックしてください。
そして、種別で「学習」を選択してください。
「API用モデル名」と「概要」は自由に設定してください。
設定後、「作成」をクリックしてください。
すると作成済みの API 一覧が表示されます。該当する API の行を選択すると、右側にパネルが開きます。このパネルで API キー と 学習用モデルID を取得してください（この2つの値が API の利用に必要です）。
※ 下の画面のように、API キーが表示されていない場合は「APIキーを作成」をクリックすることでAPIキーが作成されます。
学習 API の利用手順
以下は実行手順の全体像を示した図となります。
手順の全体像
以下にPython、Bash(cURL)、PowerShell 7系でのサンプルコードを記載します。
セキュリティに関する注意
本ドキュメントのサンプルコードでは、説明の簡略化のため API キーをスクリプト内に直接記載しています。
本番環境で運用する際は、以下のような方法で API キーを安全に管理してください。
- 環境変数を利用する
- シークレット管理ツール(AWS Secrets Manager、HashiCorp Vault など)を利用する
API キーをソースコードや Git リポジトリにハードコードしないようご注意ください。
学習で使用するCSVデータは、Node-AI 上でモデル学習を実施した時に指定した説明変数を含むCSVデータを準備してください。
CSVファイルのエンコーディングは UTF-8(BOMなし)を推奨します。
Python
などのファイル名で保存し、サンプルコード上部にコメントで記載されている必要な設定を行うことで、Pythonで実行することができます。
Pythonはサポート期間中のものを利用することを推奨します。
どのバージョンの Python がサポート期間中であるかについての詳細は、以下のページを参照してください。
また、ライブラリ を追加でインストールする必要があります。未インストールの場合は、以下のインストールコマンドを実行してください。
Bash(cURL)
などのファイル名で保存し、 などで実行権限を付与します。その後、サンプルコード上部にコメントで記載されている必要な設定を行うことで実行することが可能です。
以下のスクリプトは Linux、Mac、Windows の Bash 環境で動作します。 および コマンドが使用できる環境が必要です。
PowerShell 7系
などのファイル名で保存し、サンプルコード上部にコメントで記載されている必要な設定を行うことで、PowerShell で実行することができます。
以下のスクリプトは PowerShell 7.x のインストールが必要です。
PowerShell 7.x のインストール方法は、公式ドキュメントを参照してください。