freedak/timesfm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix swapped xreg_mode descriptions in forecast_with_covariates docstring

Browse Source 
The docstring had the descriptions for "xreg + timesfm" and
"timesfm + xreg" modes swapped relative to the implementation.

Fixes #275
This commit is contained in:
Yasunori Morishima（盛島康徳）
2026-03-19 11:11:55 +00:00
parent a3beaa8421
commit babdee5208
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/timesfm/timesfm_2p5/timesfm_2p5_base.py
+2 -2
View File
@@ -221,8 +221,8 @@ class TimesFM_2p5:
dynamic_categorical_covariates: A dict of dynamic categorical covariates.
static_numerical_covariates: A dict of static numerical covariates.
static_categorical_covariates: A dict of static categorical covariates.
xreg_mode: one of "xreg + timesfm" or "timesfm + xreg". "xreg + timesfm"
fits a model on the residuals of the TimesFM forecast. "timesfm + xreg"
xreg_mode: one of "xreg + timesfm" or "timesfm + xreg". "timesfm + xreg"
fits a model on the residuals of the TimesFM forecast. "xreg + timesfm"
fits a model on the targets then forecasts on the residuals via TimesFM.
normalize_xreg_target_per_input: whether to normalize the xreg target per
input in the given batch.