Bagikan melalui

ForecastingPipelineWrapperBase Kelas

  • Referensi

Kelas dasar untuk pembungkus model prakiraan.

Warisan
ABC
ForecastingPipelineWrapperBase

Konstruktor

ForecastingPipelineWrapperBase(ts_transformer: TimeSeriesTransformer | None = None, y_transformer: Pipeline | None = None, metadata: Dict[str, Any] | None = None)

Parameter

Nama Deskripsi
ts_transformer
Nilai default: None
y_transformer
Nilai default: None
metadata
Nilai default: None

Metode

align_output_to_input

Sejajarkan bingkai data output yang ditransformasikan ke bingkai data input.

Catatan: ditransformasi akan dimodifikasi dengan referensi, tidak ada salinan yang dibuat. :param X_input: Bingkai data input. :param transformed: Bingkai data setelah transformasi. :returns: Bingkai data yang ditransformasi dengan indeks aslinya, tetapi diurutkan seperti pada X_input.
fit

Paskan model dengan input X dan y.
forecast

Lakukan prakiraan pada X_pred bingkai data.
forecast_quantiles

Dapatkan prediksi dan kuantil dari alur yang dipasang.
is_grain_dropped

Mengembalikan true jika grain akan dihilangkan.
preaggregate_data_set

Agregat himpunan data prediksi.

Catatan: Metode ini tidak menjamin bahwa himpunan data akan diagregatkan. Ini hanya akan terjadi jika himpunan data berisi stempel waktu duplikat atau tanggal keluar dari kisi. :param df: Himpunan data yang akan diagregatkan. :patam y: Nilai target. :param is_training_set: Jika true, data mewakili set pelatihan. :return: Himpunan data teragregasi atau utuh jika tidak diperlukan agregasi.
preprocess_pred_X_y

Prediksi pra-proses X dan y.
rolling_evaluation

" Menghasilkan prakiraan pada asal rolling di atas set tes yang diberikan.

Setiap perulangan membuat prakiraan untuk periode 'max_horizon' berikutnya sehubungan dengan asal saat ini, kemudian memajukan asal dengan durasi waktu horizon. Konteks prediksi untuk setiap prakiraan ditetapkan, sehingga forecaster menggunakan nilai target aktual sebelum waktu asal saat ini untuk membangun fitur lag.

Fungsi ini mengembalikan DataFrame gabungan dari prakiraan bergulir yang digabungkan dengan aktual dari set pengujian.

Metode ini tidak digunakan lagi dan akan dihapus dalam rilis mendatang. Silakan gunakan rolling_forecast() sebagai gantinya.
rolling_forecast

Menghasilkan prakiraan pada asal bergulir melalui set pengujian.

Setiap iterasi membuat prakiraan periode horizon maksimum ke depan menggunakan informasi hingga asal saat ini, kemudian memajukan asal dengan periode waktu 'langkah'. Konteks prediksi untuk setiap prakiraan diatur sehingga prakiraan menggunakan nilai target aktual sebelum waktu asal saat ini untuk membangun fitur lookback.

Fungsi ini mengembalikan DataFrame prakiraan bergulir yang bergabung dengan aktual dari set pengujian. Kolom dalam bingkai data yang dikembalikan adalah sebagai berikut:

  • Kolom ID Timeseries (Opsional). Ketika disediakan oleh pengguna, nama kolom yang diberikan akan digunakan.

  • Kolom asal prakiraan memberikan waktu asal untuk setiap baris.

    Nama kolom: disimpan sebagai variabel anggota objek forecast_origin_column_name.

  • Kolom waktu. Nama kolom yang diberikan oleh pengguna akan digunakan.

  • Kolom nilai prakiraan. Nama kolom: disimpan sebagai anggota objek forecast_column_name

  • Kolom nilai aktual. Nama kolom: disimpan sebagai anggota objek actual_column_name
short_grain_handling

Mengembalikan nilai true jika penanganan grain pendek atau tidak diaktifkan untuk model.
static_preaggregate_data_set

Agregat himpunan data prediksi.

Catatan: Metode ini tidak menjamin bahwa himpunan data akan diagregatkan. Ini hanya akan terjadi jika himpunan data berisi stempel waktu duplikat atau tanggal keluar dari kisi. :param ts_transformer: Rangkaian waktu yang digunakan transformator untuk pelatihan. :param time_column_name: nama kolom waktu. :param grain_column_names: Daftar nama kolom grain. :param df: Himpunan data yang akan diagregatkan. :patam y: Nilai target. :param is_training_set: Jika true, data mewakili set pelatihan. :return: Himpunan data teragregasi atau utuh jika tidak diperlukan agregasi.

align_output_to_input

Sejajarkan bingkai data output yang ditransformasikan ke bingkai data input.

Catatan: ditransformasi akan dimodifikasi dengan referensi, tidak ada salinan yang dibuat. :param X_input: Bingkai data input. :param transformed: Bingkai data setelah transformasi. :returns: Bingkai data yang ditransformasi dengan indeks aslinya, tetapi diurutkan seperti pada X_input.

align_output_to_input(X_input: DataFrame, transformed: DataFrame) -> DataFrame

Parameter

Nama Deskripsi
X_input
Diperlukan
transformed
Diperlukan

fit

Paskan model dengan input X dan y.

fit(X: DataFrame, y: ndarray) -> ForecastingPipelineWrapperBase

Parameter

Nama Deskripsi
X
Diperlukan

Input data X.
y
Diperlukan

Masukkan data y.

forecast

Lakukan prakiraan pada X_pred bingkai data.

forecast(X_pred: DataFrame | None = None, y_pred: ndarray | DataFrame | None = None, forecast_destination: Timestamp | None = None, ignore_data_errors: bool = False) -> Tuple[ndarray, DataFrame]

Parameter

Nama Deskripsi
X_pred

bingkai data prediksi yang menggabungkan X_past dan X_future secara berurutan. Nilai kosong dalam X_pred akan diperhitungkan.

Nilai default: None
y_pred

nilai target yang menggabungkan nilai pasti untuk nilai y_past dan nilai yang hilang untuk Y_future. Jika Tidak Ada, prediksi akan dibuat untuk setiap X_pred.

Nilai default: None
forecast_destination
<xref:pandas.Timestamp>

Forecast_destination: nilai stempel waktu. Prakiraan akan dibuat sampai ke waktu forecast_destination, untuk semua grain. Input kamus { grain -> stempel waktu } tidak akan diterima. Jika forecast_destination tidak diberikan, itu akan diperhitungkan sebagai yang terakhir kali terjadi dalam X_pred untuk setiap grain.

Nilai default: None
ignore_data_errors
bool

Abaikan kesalahan dalam data pengguna.

Nilai default: False

Mengembalikan

Jenis Deskripsi
tuple

Y_pred, dengan subframe yang sesuai dengan Y_future diisi dengan prakiraan masing-masing. Setiap nilai yang hilang dalam Y_past akan diisi oleh imputer.

forecast_quantiles

Dapatkan prediksi dan kuantil dari alur yang dipasang.

forecast_quantiles(X_pred: DataFrame | None = None, y_pred: ndarray | DataFrame | None = None, quantiles: float | List[float] | None = None, forecast_destination: Timestamp | None = None, ignore_data_errors: bool = False) -> DataFrame

Parameter

Nama Deskripsi
X_pred

bingkai data prediksi yang menggabungkan X_past dan X_future secara berurutan. Nilai kosong dalam X_pred akan diperhitungkan.

Nilai default: None
y_pred

nilai target yang menggabungkan nilai pasti untuk nilai y_past dan nilai yang hilang untuk Y_future. Jika Tidak Ada, prediksi akan dibuat untuk setiap X_pred.

Nilai default: None
quantiles
float atau list of <xref:floats>

Daftar kuantil yang ingin kita prakirakan.

Nilai default: None
forecast_destination
<xref:pandas.Timestamp>

Forecast_destination: nilai stempel waktu. Prakiraan akan dibuat sampai ke waktu forecast_destination, untuk semua grain. Input kamus { grain -> stempel waktu } tidak akan diterima. Jika forecast_destination tidak diberikan, itu akan diperhitungkan sebagai yang terakhir kali terjadi dalam X_pred untuk setiap grain.

Nilai default: None
ignore_data_errors
bool

Abaikan kesalahan dalam data pengguna.

Nilai default: False

Mengembalikan

Jenis Deskripsi

Kerangka data yang berisi kolom dan prediksi yang dibuat pada kuantil yang diminta.

is_grain_dropped

Mengembalikan true jika grain akan dihilangkan.

is_grain_dropped(grain: Tuple[str] | str | List[str]) -> bool

Parameter

Nama Deskripsi
grain
Diperlukan

Grain untuk menguji apakah akan dihilangkan.

Mengembalikan

Jenis Deskripsi

True jika grain akan dihilangkan.

preaggregate_data_set

Agregat himpunan data prediksi.

Catatan: Metode ini tidak menjamin bahwa himpunan data akan diagregatkan. Ini hanya akan terjadi jika himpunan data berisi stempel waktu duplikat atau tanggal keluar dari kisi. :param df: Himpunan data yang akan diagregatkan. :patam y: Nilai target. :param is_training_set: Jika true, data mewakili set pelatihan. :return: Himpunan data teragregasi atau utuh jika tidak diperlukan agregasi.

preaggregate_data_set(df: DataFrame, y: ndarray | None = None, is_training_set: bool = False) -> Tuple[DataFrame, ndarray | None]

Parameter

Nama Deskripsi
df
Diperlukan
y
Nilai default: None
is_training_set
Nilai default: False

preprocess_pred_X_y

Prediksi pra-proses X dan y.

preprocess_pred_X_y(X_pred: DataFrame | None = None, y_pred: ndarray | DataFrame | None = None, forecast_destination: Timestamp | None = None) -> Tuple[DataFrame, DataFrame | ndarray, Dict[str, Any]]

Parameter

Nama Deskripsi
X_pred
Nilai default: None
y_pred
Nilai default: None
forecast_destination
Nilai default: None

rolling_evaluation

" Menghasilkan prakiraan pada asal rolling di atas set tes yang diberikan.

Setiap perulangan membuat prakiraan untuk periode 'max_horizon' berikutnya sehubungan dengan asal saat ini, kemudian memajukan asal dengan durasi waktu horizon. Konteks prediksi untuk setiap prakiraan ditetapkan, sehingga forecaster menggunakan nilai target aktual sebelum waktu asal saat ini untuk membangun fitur lag.

Fungsi ini mengembalikan DataFrame gabungan dari prakiraan bergulir yang digabungkan dengan aktual dari set pengujian.

Metode ini tidak digunakan lagi dan akan dihapus dalam rilis mendatang. Silakan gunakan rolling_forecast() sebagai gantinya.

rolling_evaluation(X_pred: DataFrame, y_pred: DataFrame | ndarray, ignore_data_errors: bool = False) -> Tuple[ndarray, DataFrame]

Parameter

Nama Deskripsi
X_pred
Diperlukan

bingkai data prediksi yang menggabungkan X_past dan X_future secara berurutan. Nilai kosong dalam X_pred akan diperhitungkan.
y_pred
Diperlukan

nilai target yang sesuai dengan X_pred.
ignore_data_errors

Abaikan kesalahan dalam data pengguna.

Nilai default: False

Mengembalikan

Jenis Deskripsi
tuple

Y_pred, dengan subframe yang sesuai dengan Y_future diisi dengan prakiraan masing-masing. Setiap nilai yang hilang dalam Y_past akan diisi oleh imputer.

rolling_forecast

Menghasilkan prakiraan pada asal bergulir melalui set pengujian.

Setiap iterasi membuat prakiraan periode horizon maksimum ke depan menggunakan informasi hingga asal saat ini, kemudian memajukan asal dengan periode waktu 'langkah'. Konteks prediksi untuk setiap prakiraan diatur sehingga prakiraan menggunakan nilai target aktual sebelum waktu asal saat ini untuk membangun fitur lookback.

Fungsi ini mengembalikan DataFrame prakiraan bergulir yang bergabung dengan aktual dari set pengujian. Kolom dalam bingkai data yang dikembalikan adalah sebagai berikut:

  • Kolom ID Timeseries (Opsional). Ketika disediakan oleh pengguna, nama kolom yang diberikan akan digunakan.

  • Kolom asal prakiraan memberikan waktu asal untuk setiap baris.

    Nama kolom: disimpan sebagai variabel anggota objek forecast_origin_column_name.

  • Kolom waktu. Nama kolom yang diberikan oleh pengguna akan digunakan.

  • Kolom nilai prakiraan. Nama kolom: disimpan sebagai anggota objek forecast_column_name

  • Kolom nilai aktual. Nama kolom: disimpan sebagai anggota objek actual_column_name

rolling_forecast(X_pred: DataFrame, y_pred: ndarray, step: int = 1, ignore_data_errors: bool = False) -> DataFrame

Parameter

Nama Deskripsi
X_pred
Diperlukan
<xref:pd.DataFrame>

Bingkai data prediksi
y_pred
Diperlukan
<xref:np.ndarray>

nilai target yang terkait dengan baris dalam X_pred
step
int

Jumlah periode untuk memajukan jendela prakiraan di setiap perulangan.

Nilai default: 1
ignore_data_errors
bool

Abaikan kesalahan dalam data pengguna.

Nilai default: False

Mengembalikan

Jenis Deskripsi
<xref:pd.DataFrame>

Bingkai data prakiraan bergulir

short_grain_handling

Mengembalikan nilai true jika penanganan grain pendek atau tidak diaktifkan untuk model.

short_grain_handling() -> bool

static_preaggregate_data_set

Agregat himpunan data prediksi.

Catatan: Metode ini tidak menjamin bahwa himpunan data akan diagregatkan. Ini hanya akan terjadi jika himpunan data berisi stempel waktu duplikat atau tanggal keluar dari kisi. :param ts_transformer: Rangkaian waktu yang digunakan transformator untuk pelatihan. :param time_column_name: nama kolom waktu. :param grain_column_names: Daftar nama kolom grain. :param df: Himpunan data yang akan diagregatkan. :patam y: Nilai target. :param is_training_set: Jika true, data mewakili set pelatihan. :return: Himpunan data teragregasi atau utuh jika tidak diperlukan agregasi.

static static_preaggregate_data_set(ts_transformer: TimeSeriesTransformer, time_column_name: str, grain_column_names: List[str], df: DataFrame, y: ndarray | None = None, is_training_set: bool = False) -> Tuple[DataFrame, ndarray | None]

Parameter

Nama Deskripsi
ts_transformer
Diperlukan
time_column_name
Diperlukan
grain_column_names
Diperlukan
df
Diperlukan
y
Nilai default: None
is_training_set
Nilai default: False

Atribut

actual_column_name

forecast_column_name

forecast_origin_column_name

grain_column_list

max_horizon

Kembalikan horizon maksimum yang digunakan dalam model.

origin_col_name

Kembalikan nama kolom asal.

target_lags

Target pengembalian tertinggal jika ada.

target_rolling_window_size

Kembalikan ukuran jendela bergulir.

time_column_name

Kembalikan nama kolom waktu.

user_target_column_name

y_max_dict

Mengembalikan kamus dengan nilai target maksimal menurut ID rangkaian waktu

y_min_dict

Mengembalikan kamus dengan nilai target minimal menurut ID rangkaian waktu

FATAL_NO_TARGET_IMPUTER 

FATAL_NO_TARGET_IMPUTER = 'No target imputers were found in TimeSeriesTransformer.'

FATAL_NO_TS_TRANSFORM 

FATAL_NO_TS_TRANSFORM = 'The time series transform is absent. Please try training model again.'