DOC Rework plot_document_clustering.py example #23528

ArturoAmorQ · 2022-06-02T15:21:24Z

Reference Issues/PRs

Related to #22928 and #23266

What does this implement/fix? Explain your changes.

This is the third release of the revamped examples to serve as a tutorial series on text analysis.

Any other comments?

Side effect: Implements notebook style as intended in #22406

…nto doc_clustering

ogrisel · 2022-06-03T09:25:23Z

Can you please merge the main branch back to this PR to see if #23508 fixes the doc build?

…nto doc_clustering

lesteve · 2022-06-03T10:12:33Z

Can you please merge the main branch back to this PR to see if #23508 fixes the doc build?

The CircleCI hosting job is triggered but there is no "check the rendered doc" direct link to the artifact yet, see #23534 (comment) for more details.

ogrisel · 2022-06-07T09:50:38Z

The doc ci is broken because the k-means ++ init on very sparse data can select initial centroids than never get updated and this cause problems in the silhouette clustering evaluation.

The example build log is very verbose and it takes time to render in firefox when scrolling. Here is a PR to make the log size much more manageable: #23557.

…into doc_clustering

glemaitre

A couple of comments.

examples/text/plot_document_clustering.py

Co-authored-by: Guillaume Lemaitre <[email protected]>

jjerphan

Thank you for this contribution, @ArturoAmorQ! 🙂

Here are some comments and suggestion.

In a nutshell, I suggest that:

sentences can sometimes be shorter and their meaning more accurate
Sphinx references can be adapted as
```
:func:`~*`
```
should be changed to:
```
:class:`~*`
```
when referencing classes.
cross-reference can be made when content already exist in the documentation

examples/text/plot_document_clustering.py

Co-authored-by: Julien Jerphanion <[email protected]>

examples/text/plot_document_clustering.py

Co-authored-by: Olivier Grisel <[email protected]>

…nto doc_clustering

ogrisel

This looks great! Just a final batch of suggestions.

Thank you very much @ArturoAmorQ!

examples/text/plot_document_clustering.py

Co-authored-by: Olivier Grisel <[email protected]>

examples/text/plot_document_clustering.py

Co-authored-by: Julien Jerphanion <[email protected]>

…into doc_clustering

ogrisel · 2022-06-20T14:14:31Z

There seem to be a problem with doc-min-dependencies: the last two commits had run that lasted for hours and I could not see the output in the github actions web interface. So I cancelled them. I will push a new commit to see if it still happens.

…nto doc_clustering

ArturoAmorQ · 2022-06-20T14:25:03Z

I will push a new commit to see if it still happens.

I merged main in case that helps. Thanks for your time and valuable feedback, @ogrisel, @jjerphan and @glemaitre !

ogrisel · 2022-06-20T14:32:43Z

It seems to work indeed.

ogrisel · 2022-06-20T14:58:57Z

Merged! Thank you very much @ArturoAmorQ !

I think the linked example for adjustment for chance could also benefit from a tutorialization:

https://scikit-learn.org/dev/auto_examples/cluster/plot_adjusted_for_chance_measures.html#sphx-glr-auto-examples-cluster-plot-adjusted-for-chance-measures-py

jjerphan · 2022-06-20T14:59:41Z

Thank you, @ArturoAmorQ!

Co-authored-by: Olivier Grisel <[email protected]> Co-authored-by: Guillaume Lemaitre <[email protected]> Co-authored-by: Julien Jerphanion <[email protected]>

ArturoAmorQ added 5 commits May 23, 2022 16:28

First step to improve notebook style

595979d

Checkpoint

e73ced2

Checkpoint

3b01b5d

Merge branch 'main' of https://github.com/scikit-learn/scikit-learn i…

8d7e3e4

…nto doc_clustering

Add plots and improve narrative

812b3b3

github-actions bot added the Documentation label Jun 2, 2022

Merge branch 'main' of https://github.com/scikit-learn/scikit-learn i…

7ae069a

…nto doc_clustering

Merge branch 'main' of https://github.com/scikit-learn/scikit-learn i…

f3ddf3a

…nto doc_clustering

ogrisel added 2 commits June 6, 2022 12:42

Merge branch 'main' into doc_clustering

47d5ccb

Empty commit to trigger CI again

cbca1a1

ArturoAmorQ added 5 commits June 7, 2022 15:05

Rename benchmark function

35dc7a9

Merge branch 'doc_clustering' of github.com:ArturoAmorQ/scikit-learn …

39c52b2

…into doc_clustering

Workaround to avoid kmeans++ not updating initial centroids

be09f9e

Improve text

7a73a69

Improve narrative

126db98

glemaitre self-requested a review June 8, 2022 09:49

glemaitre reviewed Jun 8, 2022

View reviewed changes

ArturoAmorQ and others added 4 commits June 8, 2022 14:43

Apply suggestions from code review

8159abc

Co-authored-by: Guillaume Lemaitre <[email protected]>

Iter on suggestions from code review

4470450

Fix repited line

b0928ef

Modify workaround to avoid silhouette message error

a444286

jjerphan reviewed Jun 8, 2022

View reviewed changes

ArturoAmorQ and others added 5 commits June 8, 2022 15:08

Get rid of cousin

ce9b7e3

Apply suggestions from code review

172db17

Co-authored-by: Julien Jerphanion <[email protected]>

Fix conflicts

03de379

Apply suggestions from code review

5755395

Change sphinx references

1babd21

ArturoAmorQ added 2 commits June 10, 2022 15:20

Improve output from custom function

1ecc76f

Rework notebook to include error bars

59232d0

ogrisel reviewed Jun 10, 2022

View reviewed changes

examples/text/plot_document_clustering.py Outdated Show resolved Hide resolved

ogrisel reviewed Jun 10, 2022

View reviewed changes

examples/text/plot_document_clustering.py Outdated Show resolved Hide resolved

ogrisel reviewed Jun 10, 2022

View reviewed changes

examples/text/plot_document_clustering.py Outdated Show resolved Hide resolved

ArturoAmorQ and others added 4 commits June 13, 2022 10:04

Apply suggestions from code review

a6b90cc

Co-authored-by: Olivier Grisel <[email protected]>

Improve wording in conclusions

34bde7d

Remove refs to k-means++ init and improve narrative

87e9016

Merge branch 'main' of https://github.com/scikit-learn/scikit-learn i…

cd6b8d4

…nto doc_clustering

ogrisel approved these changes Jun 17, 2022

View reviewed changes

ogrisel reviewed Jun 17, 2022

View reviewed changes

examples/text/plot_document_clustering.py Outdated Show resolved Hide resolved

examples/text/plot_document_clustering.py Outdated Show resolved Hide resolved

Apply suggestions from code review

097abcb

Co-authored-by: Olivier Grisel <[email protected]>

jjerphan reviewed Jun 20, 2022

View reviewed changes

examples/text/plot_document_clustering.py Outdated Show resolved Hide resolved

ArturoAmorQ and others added 4 commits June 20, 2022 11:39

Update examples/text/plot_document_clustering.py

64a3560

Co-authored-by: Julien Jerphanion <[email protected]>

Final tweaks

66a763a

Merge branch 'doc_clustering' of github.com:ArturoAmorQ/scikit-learn …

4414849

…into doc_clustering

Specify sparcity of bag of words approach

38bf125

ogrisel and others added 2 commits June 20, 2022 16:15

Trigger CI

ea3ae4a

Merge branch 'main' of https://github.com/scikit-learn/scikit-learn i…

a214de5

…nto doc_clustering

ogrisel merged commit 0943f52 into scikit-learn:main Jun 20, 2022

ArturoAmorQ mentioned this pull request Jun 21, 2022

DOC Rework plot_adjusted_for_chance_measures.py example #23708

Merged

ArturoAmorQ deleted the doc_clustering branch June 23, 2022 15:20

Uh oh!

DOC Rework plot_document_clustering.py example #23528

DOC Rework plot_document_clustering.py example #23528

Uh oh!

Conversation

ArturoAmorQ commented Jun 2, 2022

Reference Issues/PRs

What does this implement/fix? Explain your changes.

Any other comments?

Uh oh!

ogrisel commented Jun 3, 2022

Uh oh!

lesteve commented Jun 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ogrisel commented Jun 7, 2022

Uh oh!

glemaitre left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jjerphan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ogrisel left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ogrisel commented Jun 20, 2022

Uh oh!

ArturoAmorQ commented Jun 20, 2022

Uh oh!

ogrisel commented Jun 20, 2022

Uh oh!

ogrisel commented Jun 20, 2022

Uh oh!

jjerphan commented Jun 20, 2022

Uh oh!

Uh oh!

lesteve commented Jun 3, 2022 •

edited

Loading