Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ENH] add disp parameter to sarimax to control output verbosity #5770

Merged
merged 4 commits into from Jan 17, 2024

Conversation

tvdboom
Copy link
Contributor

@tvdboom tvdboom commented Jan 17, 2024

Reference Issues/PRs

Closes #5712

What does this implement/fix? Explain your changes.

Added the disp parameter to the constructor of SARIMAX to control the verbosity of the printed convergence messages. It follows the same naming convention as other models like DynamicFactor, AutoETS, VARMAX.

What should a reviewer concentrate their feedback on?

Do I need a changelog for this?

PR checklist

For all contributions
  • I've added myself to the list of contributors with any new badges I've earned :-)
    How to: add yourself to the all-contributors file in the sktime root directory (not the CONTRIBUTORS.md). Common badges: code - fixing a bug, or adding code logic. doc - writing or improving documentation or docstrings. bug - reporting or diagnosing a bug (get this plus code if you also fixed the bug in the PR).maintenance - CI, test framework, release.
    See here for full badge reference
  • Optionally, I've added myself and possibly others to the CODEOWNERS file - do this if you want to become the owner or maintainer of an estimator you added.
    See here for further details on the algorithm maintainer role.
  • The PR title starts with either [ENH], [MNT], [DOC], or [BUG]. [BUG] - bugfix, [MNT] - CI, test framework, [ENH] - adding or improving code, [DOC] - writing or improving documentation or docstrings.
For new estimators
  • I've added the estimator to the API reference - in docs/source/api_reference/taskname.rst, follow the pattern.
  • I've added one or more illustrative usage examples to the docstring, in a pydocstyle compliant Examples section.
  • If the estimator relies on a soft dependency, I've set the python_dependencies tag and ensured
    dependency isolation, see the estimator dependencies guide.

@fkiraly fkiraly added module:forecasting forecasting module: forecasting, incl probabilistic and hierarchical forecasting enhancement Adding new functionality labels Jan 17, 2024
Copy link
Collaborator

@fkiraly fkiraly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

Left some non-blocking comments above.

Other non-blocking comments, this relates to multiple issues where fit parameters of the interfaced method are not exposed via the sktime constructor.
statsmodels - #4377
pmdarima - #2344

As you have looked into the statsmodels estimators, do you perchance know whether now all the fit_params are exposed in all estimators, so we can close the related issue #4377?

The same problem exists for other packages, in case you have some awareness there.

@tvdboom
Copy link
Contributor Author

tvdboom commented Jan 17, 2024

As you have looked into the statsmodels estimators, do you perchance know whether now all the fit_params are exposed in all estimators, so we can close the related issue #4377?

Not all estimators expose all fit parameters. SARIMAX itself for example is missing many. Also some estimators (or at least AutoREG) do expose them but they are not in the docstring (thus not in the documentation). So that ticket remains open.

@fkiraly
Copy link
Collaborator

fkiraly commented Jan 17, 2024

So that ticket remains open.

Well, if you would be kind enough to deal with it in one stroke, that would be very much appreciated. No pressure though.

@tvdboom
Copy link
Contributor Author

tvdboom commented Jan 17, 2024

Well, if you would be kind enough to deal with it in one stroke, that would be very much appreciated. No pressure though.

I'm working now and another PR for modin objects. Don't think I'll do another one after to fix that. sorry. at least not in the near future

@fkiraly fkiraly merged commit 0c00126 into sktime:main Jan 17, 2024
55 checks passed
fkiraly pushed a commit that referenced this pull request Jan 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Adding new functionality module:forecasting forecasting module: forecasting, incl probabilistic and hierarchical forecasting
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[ENH] Adding a parameter to forecasters from statsmodels to control verbosity of output
2 participants