From babdee520848e6444f02c25d73f4368b9d942542 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yasunori=20Morishima=EF=BC=88=E7=9B=9B=E5=B3=B6=E5=BA=B7?= =?UTF-8?q?=E5=BE=B3=EF=BC=89?= Date: Thu, 19 Mar 2026 11:11:55 +0000 Subject: [PATCH] docs: fix swapped xreg_mode descriptions in forecast_with_covariates docstring The docstring had the descriptions for "xreg + timesfm" and "timesfm + xreg" modes swapped relative to the implementation. Fixes #275 --- src/timesfm/timesfm_2p5/timesfm_2p5_base.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/timesfm/timesfm_2p5/timesfm_2p5_base.py b/src/timesfm/timesfm_2p5/timesfm_2p5_base.py index 5b79012..22f0df7 100644 --- a/src/timesfm/timesfm_2p5/timesfm_2p5_base.py +++ b/src/timesfm/timesfm_2p5/timesfm_2p5_base.py @@ -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.