Skip to content

DOC Adding dropdown for module 2.1 Gaussian Mixtures#26694

Merged
ArturoAmorQ merged 5 commits intoscikit-learn:mainfrom
punndcoder28:docs/dropdown-gaussian-mixtures
Sep 11, 2023
Merged

DOC Adding dropdown for module 2.1 Gaussian Mixtures#26694
ArturoAmorQ merged 5 commits intoscikit-learn:mainfrom
punndcoder28:docs/dropdown-gaussian-mixtures

Conversation

@punndcoder28
Copy link
Copy Markdown
Contributor

@punndcoder28 punndcoder28 commented Jun 24, 2023

Reference Issues/PRs

Adding dropdowns for section 2.1 Gaussian Mixtures mentioned in #26617

What does this implement/fix? Explain your changes.

Added dropdowns for the following

  1. Pros and cons of class GaussianMixture
  2. Selecting the number of components
  3. Estimation algorithms
  4. Choice of initialization method
  5. Estimation algorigthm
  6. Pros and cons of variational inference
  7. The Dirichlet process

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jun 24, 2023 •
edited
Loading

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

Generated for commit: cb5f224. Link to the linter CI: here

@lucyleeow
Copy link
Copy Markdown
Member

lucyleeow commented Jun 26, 2023

I think CI is failing due to these formatting issues:

The following documentation warnings may have been generated by PR #https://github.com/scikit-learn/scikit-learn/pull/26694:
/home/circleci/project/doc/modules/mixture.rst:96: WARNING: Field list ends without a blank line; unexpected unindent.
/home/circleci/project/doc/modules/mixture.rst:121: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/circleci/project/doc/modules/mixture.rst:183: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/circleci/project/doc/modules/mixture.rst:293: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/circleci/project/doc/modules/mixture.rst:339: WARNING: Explicit markup ends without a blank line; unexpected unindent.

see: https://app.circleci.com/pipelines/github/scikit-learn/scikit-learn/47964/workflows/99fc1965-bfe3-49cd-9523-6efc4568d0ce/jobs/240165

punndcoder28
punndcoder28 commented Jun 26, 2023
View reviewed changes
@punndcoder28
Copy link
Copy Markdown
Contributor Author

punndcoder28 commented Jun 26, 2023

Thanks @lucyleeow for pointing it out. I see that every line with the change related to |details-end| but weirdly enough do not see it for line 142 of the doc/modules/mixture.rst. Can you confirm if that is correct?

@punndcoder28 punndcoder28 force-pushed the docs/dropdown-gaussian-mixtures branch 2 times, most recently from faaaae0 to 743fa1f Compare June 26, 2023 13:15
@ArturoAmorQ ArturoAmorQ mentioned this pull request Jun 27, 2023
Closed
54 tasks
@lucyleeow
Copy link
Copy Markdown
Member

lucyleeow commented Jun 27, 2023

Current formatting problems in CI

The following documentation warnings may have been generated by PR #https://github.com/scikit-learn/scikit-learn/pull/26694:
/home/circleci/project/doc/modules/mixture.rst:96: WARNING: Field list ends without a blank line; unexpected unindent.
/home/circleci/project/doc/modules/mixture.rst:122: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/circleci/project/doc/modules/mixture.rst:185: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/circleci/project/doc/modules/mixture.rst:296: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/circleci/project/doc/modules/mixture.rst:340: WARNING: Field list ends without a blank line; unexpected unindent.
The following documentation files may have been changed by PR #https://github.com/scikit-learn/scikit-learn/pull/26694:

You can check and confirm this yourself here: https://app.circleci.com/jobs/github/scikit-learn/scikit-learn/240319
Click on the red step them scroll to the bottom

@punndcoder28 punndcoder28 force-pushed the docs/dropdown-gaussian-mixtures branch from 743fa1f to 07acad3 Compare June 27, 2023 17:00
@punndcoder28
Copy link
Copy Markdown
Contributor Author

punndcoder28 commented Jun 28, 2023

Thanks @lucyleeow with the latest commit, all checks have passed

ArturoAmorQ
ArturoAmorQ reviewed Jul 24, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@ArturoAmorQ ArturoAmorQ left a comment

Choose a reason for hiding this comment

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

Thanks for the PR @punndcoder28, here are a couple of comments.

@punndcoder28 punndcoder28 force-pushed the docs/dropdown-gaussian-mixtures branch 2 times, most recently from 10dc1e9 to 9e2bf12 Compare July 29, 2023 08:04
@punndcoder28 punndcoder28 requested a review from ArturoAmorQ July 29, 2023 09:58
@punndcoder28 punndcoder28 force-pushed the docs/dropdown-gaussian-mixtures branch from 9e2bf12 to 4288734 Compare July 29, 2023 12:07
ArturoAmorQ
ArturoAmorQ reviewed Jul 31, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@ArturoAmorQ ArturoAmorQ left a comment

Choose a reason for hiding this comment

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

Here is another batch of comments. Please try not to force-push your commits as that makes the reviewing process more difficult.

@punndcoder28
Copy link
Copy Markdown
Contributor Author

punndcoder28 commented Jul 31, 2023

Here is another batch of comments. Please try not to force-push your commits as that makes the reviewing process more difficult.

Sure. I usually amend the commits and therefore force-push the changes. Let me know what the exactly process which is followed in the repository and I will ensure I follow that

@punndcoder28 punndcoder28 requested a review from ArturoAmorQ July 31, 2023 17:56
ArturoAmorQ
ArturoAmorQ reviewed Aug 3, 2023
View reviewed changes
doc/modules/mixture.rst

|details-end|

.. _dirichlet_process:
Copy link
Copy Markdown
Member

@ArturoAmorQ ArturoAmorQ Aug 3, 2023

Choose a reason for hiding this comment

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

The dropdown seems to be breaking this cross-refrence:

image

I think we can revert this dropdown until the problem is fixed.

Copy link
Copy Markdown
Contributor Author

@punndcoder28 punndcoder28 Aug 29, 2023

Choose a reason for hiding this comment

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

Apologies for the late reply. Will remove the dropdown from Dirichlet Process. Where is this section exactly so that I can test after removing the drop-down feature

@punndcoder28 punndcoder28 force-pushed the docs/dropdown-gaussian-mixtures branch from f8132ca to 3f5d529 Compare August 29, 2023 16:11
@punndcoder28
Copy link
Copy Markdown
Contributor Author

punndcoder28 commented Aug 29, 2023

Two required tasks

  1. ci/circleci: doc
  2. ci/circleci: doc-min-dependencies

were cancelled. Is this to be expected? Since they are marked as Required

@ArturoAmorQ
Copy link
Copy Markdown
Member

ArturoAmorQ commented Sep 8, 2023

Two required tasks

1. ci/circleci: doc

2. ci/circleci: doc-min-dependencies

were cancelled. Is this to be expected?

It is indeed not expected. I am going to update your branch to see if that corrects the problem.

@punndcoder28
Copy link
Copy Markdown
Contributor Author

punndcoder28 commented Sep 9, 2023

Seems like updating the PR with changes from main branch fixed failing tasks

ArturoAmorQ
ArturoAmorQ approved these changes Sep 11, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@ArturoAmorQ ArturoAmorQ left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks @punndcoder28 for your work and patience :) merging!

@ArturoAmorQ ArturoAmorQ merged commit a6a6a47 into scikit-learn:main Sep 11, 2023
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Sep 18, 2023
@punndcoder28 @glemaitre
DOC Adding dropdown for module 2.1 Gaussian Mixtures (scikit-learn#26694
85b048e 
)
jeremiedbb pushed a commit that referenced this pull request Sep 20, 2023
@punndcoder28 @jeremiedbb
DOC Adding dropdown for module 2.1 Gaussian Mixtures (#26694)
dee4500
REDVM pushed a commit to REDVM/scikit-learn that referenced this pull request Nov 16, 2023
@punndcoder28 @REDVM
DOC Adding dropdown for module 2.1 Gaussian Mixtures (scikit-learn#26694
198c089 
)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ArturoAmorQ ArturoAmorQ ArturoAmorQ approved these changes

Assignees

No one assigned

Labels

Documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@punndcoder28 @lucyleeow @ArturoAmorQ