Skip to content

[ENH] all regressors to use "dist" kwarg for distribution input#1008

Open
joshdunnlime wants to merge 1 commit intosktime:mainfrom
joshdunnlime:dist-kwarg-unify
Open

[ENH] all regressors to use "dist" kwarg for distribution input#1008
joshdunnlime wants to merge 1 commit intosktime:mainfrom
joshdunnlime:dist-kwarg-unify

Conversation

@joshdunnlime
Copy link
Copy Markdown
Contributor

This will override any of the following: distribution, dist_type, family, etc. There is a deprecation warning with minimum switch-over period.

Reference Issues/PRs

#653

What does this implement/fix? Explain your changes.

Unifies the input kwarg name for distributions/distribution-like objects/str.

Does your contribution introduce a new dependency? If yes, which one?

No.

What should a reviewer concentrate their feedback on?

Does the new name make this clearer? Are we happy with the deprecation warning?

Did you add any tests for the change?

No.

Any other comments?

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 skpro 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
  • 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.

this will override any of the following: distribution, dist_type, family, etc. There is a deprecation warning with minimum switchover period.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant