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] Alpha distribution #356

Merged
merged 5 commits into from
May 25, 2024
Merged

Conversation

SaiRevanth25
Copy link
Contributor

@SaiRevanth25 SaiRevanth25 commented May 23, 2024

What does this implement/fix? Explain your changes.

Implements Alpha Distribution. Towards https://github.com//issues/22

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

No

Did you add any tests for the change?

No

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.

@fkiraly fkiraly changed the title [ENH]Alpha distribution [ENH] Alpha distribution May 23, 2024
@fkiraly fkiraly added enhancement module:probability&simulation probability distributions and simulators interfacing algorithms Interfacing existing algorithms/estimators from third party packages labels May 23, 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!

Not blocking, but we should:

  • add an explanation of the parameterization to the docstring - the "alpha" distribution is not a common one, so more explanation on how to obtain it would also be useful (e.g., in relation to Gaussian)
  • fix the type annotations, as @VascoSch92 suggests

@fkiraly fkiraly merged commit f3b192d into sktime:main May 25, 2024
36 checks passed
@SaiRevanth25 SaiRevanth25 deleted the alpha_distribution branch May 26, 2024 03:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement interfacing algorithms Interfacing existing algorithms/estimators from third party packages module:probability&simulation probability distributions and simulators
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants