docs: fix swapped xreg_mode descriptions and covariates typo (#275)#366
Open
aydinomer00 wants to merge 1 commit intogoogle-research:masterfrom
Open
docs: fix swapped xreg_mode descriptions and covariates typo (#275)#366aydinomer00 wants to merge 1 commit intogoogle-research:masterfrom
aydinomer00 wants to merge 1 commit intogoogle-research:masterfrom
Conversation
…research#275) The docstring for forecast_with_covariates() had the descriptions for the two xreg_mode values swapped. The implementation is correct, only the docstring was wrong. Before: 'xreg + timesfm' fits a model on the residuals of the TimesFM forecast. 'timesfm + xreg' fits a model on the targets then forecasts residuals. After (matching the actual implementation): 'xreg + timesfm' fits XReg on targets, then TimesFM forecasts residuals. 'timesfm + xreg' runs TimesFM first, then fits XReg on residuals. Also fix typo: 'covaraites' -> 'covariates' in error message (L288). Closes google-research#275
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
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
1 participant
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.
The docstring for forecast_with_covariates() had the descriptions for the two xreg_mode values swapped. The implementation is correct, only the docstring was wrong.
Before:
'xreg + timesfm' fits a model on the residuals of the TimesFM forecast.
'timesfm + xreg' fits a model on the targets then forecasts residuals.
After (matching the actual implementation):
'xreg + timesfm' fits XReg on targets, then TimesFM forecasts residuals.
'timesfm + xreg' runs TimesFM first, then fits XReg on residuals.
Also fix typo: 'covaraites' -> 'covariates' in error message (L288).
Closes #275