foundryts.functions.linear_regression

foundryts.functions.linear_regression(include_intercept=True, time_unit='ns', start=None, end=None)

単一の time series に対して線形回帰を行う関数を返します。

線形回帰は、入力 time series の点に対して最適な直線のパラメーターを求めます。線形回帰は y = Ax + B として表現され、A は直線の傾き、B は y 切片です。返される関数は、パラメーター A と B を提供します。

線形回帰は、ユーザーの time series データにおける線形トレンドを特定し、定量化する必要がある場合に便利です。

パラメーター:
- time_unit (str , optional) – 係数の時間単位で、"s"、"ms"、"us"、"ns" のいずれかである必要があります（デフォルトは "ns"）。
- start (str | int | datetime.datetime , optional) – 線形回帰を計算するための time series の開始点（含む）。
- end (str | int | datetime.datetime , optional) – 線形回帰を計算するための time series の終了点（除く）。
戻り値: 単一の time series を受け取り、線形回帰を使用して time series の点に対する最適な直線のパラメーターを返す関数。
戻り値の型: (FunctionNode) -> SummarizerNode

データフレームスキーマ

列名	型	説明
max_bounds.first_value	float	`y=Ax+B` における傾き (A) の最大値。
max_bounds.second_value	float	`y=Ax+B` における切片 (B) の最大値。
min_bounds.first_value	float	`y=Ax+B` における傾き (A) の最小値。
min_bounds.second_value	float	`y=Ax+B` における切片 (B) の最小値。
regression_fit_function. linear_regression_fit. slope	float	`y=Ax+B` における線形回帰フィットのパラメーター ‘A’ (傾き)。
regression_fit_function. linear_regression_fit. intercept	float	`y=Ax+B` における線形回帰フィットのパラメーター ‘B’ (切片)。
regression_fit_function. linear_regression_fit. statistics.rsquared	float	線形回帰の適合度を示す R-squared 値。

例

Copied!1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
>>> series = F.points(
...     (10, 6.0), (20, 12.0), (30, 24.0), (40, 48.0), (50, 96.0), name="series"
... )
# F.points() は、データポイントのシーケンスを作成します。
# 各タプルは (timestamp, value) の形式です。
# name パラメータはシリーズの名前を指定します。
>>> series.to_pandas()
                      timestamp  value
0 1970-01-01 00:00:00.000000010    6.0
1 1970-01-01 00:00:00.000000020   12.0
2 1970-01-01 00:00:00.000000030   24.0
3 1970-01-01 00:00:00.000000040   48.0
4 1970-01-01 00:00:00.000000050   96.0
# series.to_pandas() は、データを pandas の DataFrame に変換します。
# timestamp 列は Unix エポックからのナノ秒を表しています。

Copied!1
2
3
4
>>> lin_regr = F.linear_regression()(series)
>>> lin_regr.to_pandas()
   max_bounds.first_value  max_bounds.second_value  min_bounds.first_value  min_bounds.second_value  regression_fit_function.linear_regression_fit.intercept  regression_fit_function.linear_regression_fit.slope  regression_fit_function.linear_regression_fit.statistics.rsquared
0                    50.0                     96.0                    10.0                      6.0                                              -27.6                                                     2.16                                             0.870968

max_bounds.first_value と max_bounds.second_value は最大の境界値を示しています。
min_bounds.first_value と min_bounds.second_value は最小の境界値を示しています。
regression_fit_function.linear_regression_fit.intercept は回帰直線の切片を示しています。
regression_fit_function.linear_regression_fit.slope は回帰直線の傾きを示しています。
regression_fit_function.linear_regression_fit.statistics.rsquared は決定係数 (R²) を示しており、モデルの適合度を評価する指標です。