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

[DOC] changing import path for plot_cluster_algorithm #3945

Merged
merged 1 commit into from
Dec 17, 2022

Conversation

GianFree
Copy link
Contributor

@GianFree GianFree commented Dec 16, 2022

Hi devs,
thanks for this library!

I was trying to use the example in the Time Series Clustering paragraph of the Getting Started page, but plot_cluster_algorithm was not in sktime.clustering.evaluation._plot_clustering but in sktime.clustering.utils.plotting._plot_partitions.

Therefore, this PR changes this line.
I hope this might be useful for others too.

Reference Issues/PRs

What does this implement/fix? Explain your changes.

Changing the import of plot_cluster_algorithm from sktime.clustering.evaluation._plot_clustering to sktime.clustering.utils.plotting._plot_partitions.

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

What should a reviewer concentrate their feedback on?

Any other comments?

PR checklist

For all contributions
  • I've added myself to the list of contributors.
  • Optionally, I've updated sktime's CODEOWNERS to receive notifications about future changes to these files.
  • I've added unit tests and made sure they pass locally.
  • The PR title starts with either [ENH], [MNT], [DOC], or [BUG] indicating whether the PR topic is related to enhancement, maintenance, documentation, or bug.
For new estimators
  • I've added the estimator to the online documentation.
  • I've updated the existing example notebooks or provided a new one to showcase how my estimator works.

Hi devs, 
thanks for this library!

I was trying to use the example in the **Time Series Clustering** paragraph, but `plot_cluster_algorithm` was in `sktime.clustering.evaluation._plot_clustering` but in `sktime.clustering.utils.plotting._plot_partitions`.

I hope this change might be useful for others too.
Copy link
Collaborator

@miraep8 miraep8 left a comment

Choose a reason for hiding this comment

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

Nice, thank you for taking the initiative to make a PR about this. I agree it will be useful to other people as well. I separately checked out the reported bug and fix and it looks good from my end. Cheers!

@fkiraly fkiraly merged commit 8f4f3d2 into sktime:main Dec 17, 2022
@GianFree GianFree deleted the patch-1 branch December 19, 2022 09:24
fkiraly added a commit that referenced this pull request Dec 28, 2022
…t_dependencies` (#3955)

This extends `_check_soft_dependencies` to also accept single arguments that are tuples or lists of strings.

That is, formerly, it was valid to call
`_check_soft_dependencies("package1", "package2")`

but not 
`_check_soft_dependencies(("package1", "package2"))`
`_check_soft_dependencies(["package1", "package2"])`

Now all the above are valid and mean the same.

This prevents developer or user error (due to unintuitive/ambiguous signature) as was fixed in #3945
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.

None yet

4 participants