Skip to content

DOC Ensures that precision_recall_fscore_support passes numpydoc validation#22472

Merged
glemaitre merged 4 commits intoscikit-learn:mainfrom
GauravChoudhay:doc_numpy_validation
Feb 16, 2022
Merged

DOC Ensures that precision_recall_fscore_support passes numpydoc validation#22472
glemaitre merged 4 commits intoscikit-learn:mainfrom
GauravChoudhay:doc_numpy_validation

Conversation

@GauravChoudhay
Copy link
Copy Markdown
Contributor

@GauravChoudhay GauravChoudhay commented Feb 13, 2022

Reference Issues/PRs

 Address #21350

What does this implement/fix? Explain your changes.

  • Wrote missing return of precision, recall, and fscore in precision_recall_fscore_support function.
  • Verify that all the test passes after fixing the issues.
  • remove the function from FUNCTION_DOCSTRING_IGNORE_LIST.

Any other comments?

My first PR :). looking forward to contribute more

glemaitre
glemaitre reviewed Feb 14, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@glemaitre glemaitre 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 couple of comments to clarify the docstring.

GauravChoudhay and others added 3 commits February 16, 2022 02:12
@GauravChoudhay @glemaitre
Update sklearn/metrics/_classification.py
7ac6a29 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@GauravChoudhay @glemaitre
Update sklearn/metrics/_classification.py
defb3d3 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@GauravChoudhay @glemaitre
Update sklearn/metrics/_classification.py
a7c47b6 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
glemaitre
glemaitre approved these changes Feb 16, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@glemaitre glemaitre left a comment

Choose a reason for hiding this comment

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

LGTM

@glemaitre glemaitre merged commit 73e605a into scikit-learn:main Feb 16, 2022
@glemaitre
Copy link
Copy Markdown
Member

glemaitre commented Feb 16, 2022

Thanks @GauravChoudhay merging then.

@GauravChoudhay
Copy link
Copy Markdown
Contributor Author

GauravChoudhay commented Feb 17, 2022

Thank you @glemaitre . one more question sir, would i work on documentation more or can i go with code.. and any issue u can recommend me to work on will be great help

@glemaitre
Copy link
Copy Markdown
Member

glemaitre commented Feb 17, 2022

It is difficult to recommend you a specific issue because it will depend on your background.
Maybe an easier issue that does not necessarily require a lot of statistical understanding and more some programming skill is the following: #22482

Basically, you should check the deprecation documentation: https://scikit-learn.org/stable/developers/contributing.html#deprecation and other PR that do such changes.

Then, if you background is more statistical then you can check any issue that is linked to a bug that require some digging to understand where the problem is coming from.

@thomasjpfan thomasjpfan mentioned this pull request Feb 22, 2022
Closed
thomasjpfan pushed a commit to thomasjpfan/scikit-learn that referenced this pull request Mar 1, 2022
@GauravChoudhay @glemaitre @thomasjpfan
DOC Ensures that precision_recall_fscore_support passes numpydoc vali…
a9cc294 
…dation (scikit-learn#22472)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@glemaitre glemaitre glemaitre approved these changes

Assignees

No one assigned

Labels

Documentation module:metrics No Changelog Needed

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@GauravChoudhay @glemaitre @cmarmo