FORECAST¶

構文¶

CREATE [ OR REPLACE ] SNOWFLAKE.ML.FORECAST [ IF NOT EXISTS ] <name>(
  INPUT_DATA => <input_data>,
  [ SERIES_COLNAME => '<series_colname>', ]
  TIMESTAMP_COLNAME => '<timestamp_colname>',
  TARGET_COLNAME => '<target_colname>',
  [ CONFIG_OBJECT => <config_object> ]
)
[ [ WITH ] TAG ( <tag_name> = '<tag_value>' [ , <tag_name> = '<tag_value>' , ... ] ) ]
[ COMMENT = '<string_literal>' ]

CREATE SNOWFLAKE.ML.FORECAST <name>(
  '<input_data>', '<series_colname>', '<timestamp_colname>', '<target_colname>'
);

パラメーター¶

name

モデルの識別子を指定します。これは、モデルが作成されるスキーマに対して一意にする必要があります。

モデル識別子が完全修飾されていない場合（db_name.schema_name.name または schema_name.name の形式）、コマンドは、セッションの現在のスキーマにモデルを作成します。

また、識別子はアルファベット文字で始まる必要があり、識別子文字列全体が二重引用符で囲まれていない限り、スペースや特殊文字を含めることはできません（例: "My object"）。二重引用符で囲まれた識別子も大文字と小文字が区別されます。

詳細については、 識別子の要件 をご参照ください。

コンストラクター引数¶

必須:

INPUT_DATA => input_data

入力データへの 参照。参照を使用すると、制限付き権限で実行されるトレーニングプロセスで、ご自身の権限を使用してデータにアクセスできるようになります。データがすでにそのような形式になっている場合は、テーブルまたはビューへの参照を使用できます。または、 クエリ参照 を使用して、データを取得するために実行するクエリを指定することもできます。

参照されるデータは、予測モデルによって消費されるトレーニングデータ全体です。 input_data に、 timestamp_colname、 target_colname、または series_colname という名前以外の列が含まれている場合、それらは外生変数（追加特徴量）とみなされます。入力データの列の順番は重要ではありません。

入力データには、ユースケースに適した型の列が必要です。各ユースケースの詳細については、 例 をご参照ください。

ユースケース	列および型
単一時系列	タイムスタンプ列: TIMESTAMP_NTZ。 ターゲット値列: FLOAT。
複数時系列	系列の列: 数値とテキストを含む VARIANT。 タイムスタンプ列: TIMESTAMP_NTZ。 ターゲット値列: FLOAT。
外生変数を含む単一時系列	タイムスタンプ列: TIMESTAMP_NTZ。 ターゲット値列: FLOAT。 外生特徴量の列: 数値 または テキスト。
外生変数を含む複数時系列	系列の列: 数値とテキストを含む VARIANT。 タイムスタンプ列: TIMESTAMP_NTZ。 ターゲット値列: FLOAT。 外生特徴量の列: 数値 または テキスト。

TIMESTAMP_COLNAME => 'timestamp_colname'

input_data でタイムスタンプを含む列の名前。

TARGET_COLNAME => 'target_colname'

input_data でターゲット（依存値）を含む列の名前。

オプション:

SERIES_COLNAME => 'series_colname'

複数時系列モデルの場合は、 input_data 内の複数時系列を定義する列の名前。この列は、 複数系列の予測 に示すように、1つ以上の異なる列からの任意の型による値または値の配列にすることができます。

位置的に引数を提供する場合、これは 2番目 の引数にする必要があります。

CONFIG_OBJECT => config_object

モデルトレーニングジョブの構成に使用されるキーと値のペアを含む OBJECT。

キー	型	デフォルト	説明
on_error	STRING	'ABORT'	モデルトレーニングタスクのエラー処理メソッドを指定する文字列（定数）。これは、複数の系列をトレーニングする場合に最も役に立ちます。サポートされる値は次のとおりです。 'abort': いずれかの時系列でエラーが発生した場合、トレーニング操作を中止します。 'skip': トレーニングでエラーが発生した時系列はスキップします。これにより、他の時系列でもモデルトレーニングを成功させることができます。どの系列が失敗したかを確認するには、モデルの <name>!SHOW_TRAINING_LOGS メソッドを使用します。
evaluate	BOOLEAN	TRUE	評価メトリクスを生成すべきかどうか。TRUE の場合、 evaluation_config のパラメーターを使用して、クロスバリデーション用の追加モデルがトレーニングされます。
evaluation_config	OBJECT	以下の 評価構成 をご参照ください。	サンプル外評価メトリクスを生成する方法を指定するオプションの構成オブジェクト。

評価構成¶

evaluation_config オブジェクトには、クロスバリデーションを構成するキーと値のペアが含まれています。これらのパラメーターは、scikit-learnの TimeSeriesSplit に由来します。

キー	型	デフォルト	説明
n_splits	INTEGER	5	スプリットの数。
max_train_size	INTEGER またはNULL（最大値なし）。	NULL	単一トレーニングセットの最大サイズ。
test_size	INTEGER または NULL。	NULL	テストセットのサイズを制限するために使用。
gap	INTEGER	0	テストセットの前に各トレーニングセットの最後から除外するサンプル数。
prediction_interval	FLOAT	0.95	間隔メトリクスの計算に使用される予測区間。

使用上の注意¶

クラスインスタンスの 複製 は現在サポートされていません。

構文¶

SHOW SNOWFLAKE.ML.FORECAST [ LIKE <pattern> ]
  [ IN
      {
        ACCOUNT                  |

        DATABASE                 |
        DATABASE <database_name> |

        SCHEMA                   |
        SCHEMA <schema_name>     |
        <schema_name>
      }
   ]

パラメーター¶

LIKE 'pattern'

オプションで、オブジェクト名でコマンド出力をフィルタリングします。フィルターは、 SQL ワイルドカード文字（% および _）をサポートする、 大文字と小文字を区別しない パターンマッチングを使用します。

たとえば、次のパターンは 同じ 結果を返します。

... LIKE '%testing%' ...

... LIKE '%TESTING%' ...

. デフォルト: 値なし（フィルタリングは出力に非適用）。

[ IN ... ]

オプションで、コマンドのスコープを指定します。次のいずれかを指定します。

ACCOUNT

アカウント全体の記録を返します。

DATABASE、 . DATABASE db_name

現在使用中のデータベースまたは指定されたデータベース（db_name）の記録を返します。

db_name なしで DATABASE を指定し、かつデータベースが使用されていない場合、キーワードは出力に影響しません。

SCHEMA、 . SCHEMA schema_name、 . schema_name

現在使用中のスキーマまたは指定されたスキーマ（schema_name）の記録を返します。

データベースが使用中の場合、または完全修飾 schema_name （例: db.schema） を指定する場合、 SCHEMA はオプションです。

データベースが使用されていない場合は、 SCHEMA を指定しても出力には影響しません。

デフォルト: セッションで現在使用中のデータベースがあるかどうかによって異なります。

• データベース: DATABASE がデフォルトです（つまり、コマンドはデータベースで表示する権限を持つオブジェクトを返します）。

• データベースなし: ACCOUNT はデフォルトです（つまり、コマンドは、アカウントで表示する権限を持つオブジェクトを返します）。

出力¶

コマンド出力では、次の列にモデルプロパティとメタデータが提供されます。

構文¶

DROP SNOWFLAKE.ML.FORECAST [ IF EXISTS ] <name>;

パラメーター¶

name

ドロップするモデルの識別子を指定します。識別子にスペース、特殊文字、または大文字と小文字が混在する場合は、文字列全体を二重引用符で囲む必要があります。二重引用符で囲まれた識別子も大文字と小文字が区別されます。

モデル識別子が完全修飾されていない場合（db_name.schema_name.name または schema_name.name の形式）、コマンドは、セッションの現在のスキーマにあるモデルを探します。

構文¶

必要な引数は、モデルがどのようなユースケースに対してトレーニングされたかによって異なります。

外生変数なしの単一系列モデルの場合:

<name>!FORECAST(
  FORECASTING_PERIODS => <forecasting_periods>,
  [ CONFIG_OBJECT => <config_object> ]
);

外生変数ありの単一系列モデルの場合:

<name>!FORECAST(
  INPUT_DATA => <input_data>,
  TIMESTAMP_COLNAME => '<timestamp_colname>',
  [ CONFIG_OBJECT => <config_object> ]
);

外生変数なしの複数系列モデルの場合:

<name>!FORECAST(
  SERIES_VALUE => <series>,
  FORECASTING_PERIODS => <forecasting_periods>,
  [ CONFIG_OBJECT => <config_object> ]
);

外生変数ありの複数系列モデルの場合:

<name>!FORECAST(
  SERIES_VALUE => <series>,
  SERIES_COLNAME => <series_colname>,
  INPUT_DATA => <input_data>,
  TIMESTAMP_COLNAME => '<timestamp_colname>',
  [ CONFIG_OBJECT => <config_object> ]
);

引数¶

必須:

以下の引数のすべてが、すべてのユースケースに必要なわけではありません。

FORECASTING_PERIODS => forecasting_periods

外生変数なしの予測に必要。

予測に先立つステップの数。ステップとステップの間隔は、トレーニング中にモデルによって推測されます。

INPUT_DATA => input_data

外生変数ありの予測に必要。

モデルのトレーニング時に input_data として渡された、外生変数（ユーザーが提供する追加特徴量）の将来のタイムスタンプと値を含むテーブル、ビュー、クエリへの 参照。参照を使用すると、制限付き権限で実行される予測プロセスで、ご自身の権限を使用してデータにアクセスできるようになります。列はこの引数と元の外生トレーニングデータとの間で名前によってマッチングされます。

TIMESTAMP_COLNAME => 'timestamp_colname'

外生変数ありの予測に必要。

タイムスタンプを含む input_data の列の名前。

SERIES_COLNAME => 'series_colname'

外生変数ありの複数系列の予測に必要。

系列を指定する input_data の列の名前。

SERIES_VALUE => series

複数系列の予測に必要。

予測する時系列。単一値（例: 'Series A'::variant）でも VARIANT でもかまいませんが、モデルをトレーニングした系列を指定する必要があります。指定しない場合は、すべてのトレーニング済み系列が予測されます。

オプション:

CONFIG_OBJECT => config_object

予測ジョブの構成に使用されるキーと値のペアを含む OBJECT。

キー	型	デフォルト	説明
prediction_interval	FLOAT	0.95	0.0以上および1.0未満の値。デフォルト値は0.95で、将来のポイントの95%が予測結果から区間 [lower_bound, upper_bound] 内に収まると予測されることを意味します。
on_error	STRING	'ABORT'	エラー処理メソッドを指定する文字列（定数）。これは、複数の系列を予測する場合に最も役に立ちます。サポートされる値は次のとおりです。 'abort': いずれかの時系列でエラーが発生した場合、モデル予測操作を中止します。 'skip': 予測でエラーが発生した時系列はスキップします。これにより、他の時系列でも予測を成功させることができます。失敗した系列はモデル出力から除外されます。

出力¶

SERIES 列は複数系列の予測にのみ存在します。単一系列の予測にはこの列はありません。

構文¶

<name>!EXPLAIN_FEATURE_IMPORTANCE();

出力¶

SERIES 列は複数系列の予測にのみ存在します。単一系列の予測にはこの列はありません。

構文¶

<name>!SHOW_EVALUATION_METRICS();

出力¶

SERIES 列は複数系列の予測にのみ存在します。単一系列の予測にはこの列はありません。

構文¶

<name>!SHOW_TRAINING_LOGS();

出力¶

SERIES 列は複数系列モデルにのみ存在します。単一系列モデルにはこの列はありません。