8000 DOC Added dropdowns to 6.2 feature-extraction by Kishan-Ved · Pull Request #26807 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]

Skip to content

DOC Added dropdowns to 6.2 feature-extraction #26807

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

Merged

Conversation

Kishan-Ved
Copy link
Contributor

Reference Issues/PRs
Add dropdowns to submodule 6.2 Feature Extraction regarding #26617.
Folded:

6.2.2.1. Implementation details (Cross referencing taken care of by adding it inside the dropdown)
6.2.3.9. Performing out-of-core scaling with HashingVectorizer

SIDE NOTE:
I am on summer vacation, I can work extensively on this and more contributions provided my PR is accepted, so I know I'm on the right track as this is my first time contributing to open source :) .

@github-actions
Copy link
github-actions bot commented Jul 8, 2023

✔️ Linting Passed

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

Generated for commit: 2ff2c90. Link to the linter CI: here

@Kishan-Ved Kishan-Ved changed the title Added dropdowns to 6.2 feature-extraction DOC Added dropdowns to 6.2 feature-extraction Jul 8, 2023
@Kishan-Ved
Copy link
Contributor Author

@betatim Hello, can you please help!, this is my first open source contribution :)

Copy link
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 @Kishan-Ved!

I think this section can still make use of more dropdowns, e.g.:

  • a dropdown for "using stop words" in 6.2.3.3
  • a dropdown for "worked-out example" in 6.2.3.4
  • a dropdown for "troubleshooting decoding text" in 6.2.3.5
  • a dropdown for "tips and tricks" in 6.2.3.9

Comment on lines 227 to 228
.. topic:: References:
* `MurmurHash3 <https://github.com/aappleby/smhasher>`_.
Copy link
Member

Choose a reason for hiding this comment

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

The reference is not being rendered because it needs an extra space:

Suggested change
.. topic:: References:
* `MurmurHash3 <https://github.com/aappleby/smhasher>`_.
.. topic:: References:
* `MurmurHash3 <https://github.com/aappleby/smhasher>`_.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have fixed this, thank you. I have also added the 4 dropdowns that you have mentioned, please review the PR for a merge.

Updated based on the review by @ArturoAmorQ.
Added:
- A dropdown for "using stop words" in 6.2.3.3
- A dropdown for "worked-out example" in 6.2.3.4
- A dropdown for "troubleshooting decoding text" in 6.2.3.5
- A dropdown for "tips and tricks" in 6.2.3.9
Copy link
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.

Just a tweak. Otherwise LGTM!

@@ -490,6 +497,10 @@ class::
Again please see the :ref:`reference documentation
<text_feature_extraction_ref>` for the details on all the parameters.

|details-start|
Example
Copy link
Member

Choose a reason for hiding this comment

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

Maybe we can be a bit more explicit here:

Suggested change
Example
Numeric example of a tf-idf matrix

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've done it, thanks for the suggestion! Kindly check.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good to go? @ArturoAmorQ

@ArturoAmorQ
Copy link
Member

Good to go? @ArturoAmorQ

On my side, yes. We need another approval, though.

Copy link
Contributor
@raph333 raph333 left a comment

Choose a reason for hiding this comment

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

The changes look good to me. Thanks for your work!

But since I'm a newbie here, we still need another review :-)

@ArturoAmorQ
Copy link
Member

We need another approval, though.

According to the Decision making process I think we can consider this as a "minor documentation change" and should be good to go with my approval.

Long story short, I am merging this one. Thanks again for your work and patience @Kishan-Ved :)

@ArturoAmorQ ArturoAmorQ merged commit 43b5757 into scikit-learn:main Sep 13, 2023
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Sep 18, 2023
REDVM pushed a commit to REDVM/scikit-learn that referenced this pull request Nov 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0