Skip to content

docs: rm type hints in ignite.contrib.metrics (6) #1688

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 17 commits into from
Feb 25, 2021
Merged

docs: rm type hints in ignite.contrib.metrics (6) #1688

merged 17 commits into from
Feb 25, 2021

Conversation

ydcjeff
Copy link
Contributor

@ydcjeff ydcjeff commented Feb 23, 2021 •
edited
Loading

Part of #1665
fixes #1665
https://deploy-preview-1688--pytorch-ignite-preview.netlify.app/contrib/metrics.html

Description:

  • remove type hints in ignite.contrib.metrics
  • add missing doc string

Check list:

  • New tests are added (if a new feature is added)
  • New doc strings: description and/or example code are in RST format
  • Documentation is updated (if required)

@ydcjeff ydcjeff marked this pull request as draft February 23, 2021 11:52
@ydcjeff ydcjeff changed the title docs: rm type hints in ignite.contrib.metrics docs: rm type hints in ignite.contrib.metrics (6) Feb 23, 2021
@ydcjeff ydcjeff marked this pull request as ready for review February 23, 2021 15:32
@vfdev-5 vfdev-5 requested review from fco-dv and sdesrozis February 24, 2021 13:03
vfdev-5
vfdev-5 approved these changes Feb 24, 2021
View reviewed changes
Copy link
Collaborator

@vfdev-5 vfdev-5 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM! Thanks a lot @ydcjeff !

sdesrozis
sdesrozis reviewed Feb 24, 2021
View reviewed changes
@sdesrozis
Copy link
Contributor

@ydcjeff I left comments

@ydcjeff ydcjeff requested a review from sdesrozis February 25, 2021 07:31
sdesrozis
sdesrozis approved these changes Feb 25, 2021
View reviewed changes
Copy link
Contributor

@sdesrozis sdesrozis left a comment

Choose a reason for hiding this comment

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

@ydcjeff Thank you ! Looks good to me.

@vfdev-5 vfdev-5 mentioned this pull request Feb 25, 2021
Closed
@vfdev-5 vfdev-5 merged commit 0a2ef9b into pytorch:master Feb 25, 2021
@ydcjeff ydcjeff deleted the ignite.contrib.metrics branch February 25, 2021 17:00
vfdev-5 added a commit that referenced this pull request Mar 1, 2021
@vfdev-5 @sdesrozis
docs: rm type hints in ignite.contrib.metrics (6) (#1688)
930d174 
* docs: rm type hints in ignite.metrics

* docs: rm type hints in ignite.distributed

* docs: rm type hints in ignite.contrib.metrics

* fix: sphinx back to 3.2.1

* Revert "docs: rm type hints in ignite.metrics"

This reverts commit a94b50e.

* Revert "docs: rm type hints in ignite.distributed"

This reverts commit 2179df5.

* remove unnecessary device, __init__

* add Metric.__init__ docstring for no __init__ for contrib.metrics

Co-authored-by: vfdev <vfdev.5@gmail.com>
Co-authored-by: Sylvain Desroziers <sylvain.desroziers@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vfdev-5 vfdev-5 vfdev-5 approved these changes

@fco-dv fco-dv Awaiting requested review from fco-dv

+1 more reviewer

@sdesrozis sdesrozis sdesrozis approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Use autodoc_typehints = "description" in conf.py
3 participants
@ydcjeff @sdesrozis @vfdev-5