Skip to content

DOC Adding Dropdown to module 7.2 Realworld Datasets#26693

Merged
ArturoAmorQ merged 5 commits intoscikit-learn:mainfrom
punndcoder28:docs/collapsible-real-world-datasets
Sep 11, 2023
Merged

DOC Adding Dropdown to module 7.2 Realworld Datasets#26693
ArturoAmorQ merged 5 commits intoscikit-learn:mainfrom
punndcoder28:docs/collapsible-real-world-datasets

Conversation

@punndcoder28
Copy link
Copy Markdown
Contributor

@punndcoder28 punndcoder28 commented Jun 24, 2023

Reference Issues/PRs

Adding dropdowns for section 7.2 Real world datasets mentioned in #26617

What does this implement/fix? Explain your changes.

Added dropdowns for the following

  1. The 20 newsgroups text dataset Usage
  2. The 20 newsgroups text dataset Converting text to vectors
  3. The 20 newsgroups text dataset Filtering texts for more realistic training
  4. The Labeled Faces in the Wild face recognition dataset Usage

@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: 1227c81. Link to the linter CI: here

@punndcoder28 punndcoder28 changed the title doc: adding dropdown for realworld datasets docs DOC Adding Dropdown to module 7.2 Realworld Datasets Jun 24, 2023
greyisbetter
greyisbetter reviewed Jun 25, 2023
View reviewed changes
Copy link
Copy Markdown
Contributor

@greyisbetter greyisbetter left a comment

Choose a reason for hiding this comment

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

In this case, I think it's better that we should hide these:

  • 7.2.2.3. Filtering text for more realistic training
  • Data Considerations
  • Recommendation
  • Examples
  • 7.2.6. Kddcup 99 dataset
  • Dataset structures
  • References

And also use asterisk in title:

|details-start|
**<title>**
|details-split|
...

@punndcoder28
Copy link
Copy Markdown
Contributor Author

punndcoder28 commented Jun 25, 2023 •
edited
Loading

The base issue mentions that we should avoid adding the Examples within a drop down and therefore I have avoided that.

narrative that may only interest users that want to go beyond the pragmatics of a given tool

From this we can see that the entire Filtering texts for more realistic training section could be made into a drop-down because it delves more into the specifics targeting only specific users which justifies my decision to hide the entire section instead. The Kddcup 99 dataset section talks about the dataset in general which can be of interest to general users but the different structures like SA, SF could be hidden instead

@punndcoder28 punndcoder28 force-pushed the docs/collapsible-real-world-datasets branch 2 times, most recently from a889c1d to def99be Compare June 25, 2023 14:49
@ArturoAmorQ ArturoAmorQ mentioned this pull request Jun 27, 2023
Closed
54 tasks
@punndcoder28 punndcoder28 force-pushed the docs/collapsible-real-world-datasets branch from def99be to 7a601c9 Compare June 27, 2023 17:04
@ArturoAmorQ
Copy link
Copy Markdown
Member

ArturoAmorQ commented Jul 25, 2023

I'm fine the current status of the PR, i.e. without hiding the Kddcup 99 dataset mentions to SA and SF; nor the sections on data considerations and recommendation of the 20 newsgroup.

Now that you're working on it, I just realized that section 7.2.3.2. Examples should be a .. topic:: directive instead. Can you please take care of it?

@punndcoder28
Copy link
Copy Markdown
Contributor Author

punndcoder28 commented Jul 29, 2023

I'm fine the current status of the PR, i.e. without hiding the Kddcup 99 dataset mentions to SA and SF; nor the sections on data considerations and recommendation of the 20 newsgroup.

Now that you're working on it, I just realized that section 7.2.3.2. Examples should be a .. topic:: directive instead. Can you please take care of it?

Sure, will change that

@punndcoder28 punndcoder28 force-pushed the docs/collapsible-real-world-datasets branch from bafc4ea to 01874a1 Compare July 29, 2023 12:09
punndcoder28
punndcoder28 commented Jul 29, 2023
View reviewed changes
ArturoAmorQ
ArturoAmorQ reviewed Jul 31, 2023
View reviewed changes
ArturoAmorQ
ArturoAmorQ reviewed Sep 8, 2023
View reviewed changes
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 again @punndcoder28 :) merging!

@ArturoAmorQ ArturoAmorQ merged commit d3aaa75 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 to module 7.2 Realworld Datasets (scikit-learn#26693
aaf514b 
)
jeremiedbb pushed a commit that referenced this pull request Sep 20, 2023
@punndcoder28 @jeremiedbb
DOC Adding Dropdown to module 7.2 Realworld Datasets (#26693)
5c44780
REDVM pushed a commit to REDVM/scikit-learn that referenced this pull request Nov 16, 2023
@punndcoder28 @REDVM
DOC Adding Dropdown to module 7.2 Realworld Datasets (scikit-learn#26693
213ee73 
)
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

@greyisbetter greyisbetter Awaiting requested review from greyisbetter

Assignees

No one assigned

Labels

Documentation module:datasets

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@punndcoder28 @ArturoAmorQ @greyisbetter