docs: fix swapped xreg_mode descriptions in forecast_with_covariates#376
Merged
siriuz42 merged 1 commit intogoogle-research:masterfrom Mar 19, 2026
Merged
Conversation
…docstring The docstring had the descriptions for "xreg + timesfm" and "timesfm + xreg" modes swapped relative to the implementation. Fixes google-research#275
Collaborator
|
Thanks for the fix, @yasumorishima ! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fix incorrect docstring for
xreg_modeparameter inforecast_with_covariates.The descriptions for
"xreg + timesfm"and"timesfm + xreg"modes were swapped relative to the actual implementation:"timesfm + xreg"forecasts via TimesFM first, then fits a model on the residuals (L267, L321)"xreg + timesfm"fits a model on the targets directly (L270)The docstring had these descriptions reversed.
Fixes #275