Skip to content

Conversation

sadra-barikbin
Copy link
Collaborator

Description:

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)

@github-actions github-actions bot added docs module: contrib Contrib module module: distributed Distributed module module: metrics Metrics module labels May 29, 2023
Copy link
Collaborator

@vfdev-5 vfdev-5 left a comment

Choose a reason for hiding this comment

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

Thanks a lot for the PR, @sadra-barikbin !
I left several comments to improve the code and the API

@sadra-barikbin sadra-barikbin requested a review from vfdev-5 June 5, 2023 09:35
Copy link
Collaborator

@vfdev-5 vfdev-5 left a comment

Choose a reason for hiding this comment

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

@sadra-barikbin thanks for the update, there is a nit improvement for docstring. I'll check tests in more details a bit later.
Please also fix current problem with docs rendering:
https://app.netlify.com/sites/pytorch-ignite-preview/deploys/647cf10085384f0008aea77c

11:02:30 PM: reading sources... [100%] metrics .. utils
11:02:30 PM: /opt/build/repo/ignite/metrics/running_average.py:docstring of ignite.metrics.running_average.RunningAverage:8: ERROR: Unknown interpreted text role "method".
11:02:30 PM: looking for now-outdated files... none found

@sadra-barikbin
Copy link
Collaborator Author

@sadra-barikbin thanks for the update, there is a nit improvement for docstring. I'll check tests in more details a bit later. Please also fix current problem with docs rendering: https://app.netlify.com/sites/pytorch-ignite-preview/deploys/647cf10085384f0008aea77c

11:02:30 PM: reading sources... [100%] metrics .. utils
11:02:30 PM: /opt/build/repo/ignite/metrics/running_average.py:docstring of ignite.metrics.running_average.RunningAverage:8: ERROR: Unknown interpreted text role "method".
11:02:30 PM: looking for now-outdated files... none found

What do you mean by "nit"?

@vfdev-5
Copy link
Collaborator

vfdev-5 commented Jun 5, 2023

@sadra-barikbin thanks for the update, there is a nit improvement for docstring. I'll check tests in more details a bit later. Please also fix current problem with docs rendering: https://app.netlify.com/sites/pytorch-ignite-preview/deploys/647cf10085384f0008aea77c

11:02:30 PM: reading sources... [100%] metrics .. utils
11:02:30 PM: /opt/build/repo/ignite/metrics/running_average.py:docstring of ignite.metrics.running_average.RunningAverage:8: ERROR: Unknown interpreted text role "method".
11:02:30 PM: looking for now-outdated files... none found

What do you mean by "nit"?

It's an expression to say a tiny improvement, I'm talking about this:#2958 (comment)

@sadra-barikbin sadra-barikbin force-pushed the Improvement-in-metric-usage-and-RunningAverage branch from ced1af8 to 941a524 Compare June 5, 2023 10:46
@vfdev-5 vfdev-5 closed this Jun 11, 2023
@vfdev-5 vfdev-5 reopened this Jun 11, 2023
@sadra-barikbin sadra-barikbin requested a review from vfdev-5 June 17, 2023 05:13
Copy link
Collaborator

@vfdev-5 vfdev-5 left a comment

Choose a reason for hiding this comment

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

Great work, thanks @sadra-barikbin
I left few other comments to update the code and it will be good to go

Copy link
Collaborator

@vfdev-5 vfdev-5 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 @sadra-barikbin !

@vfdev-5 vfdev-5 enabled auto-merge (squash) June 29, 2023 09:12
@vfdev-5 vfdev-5 merged commit 193643c into pytorch:master Jun 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs module: contrib Contrib module module: distributed Distributed module module: metrics Metrics module
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants