Skip to content
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

Average metrics doctest #2276

Closed

Conversation

wanjuntham
Copy link

@wanjuntham wanjuntham commented Oct 19, 2021

Fixes part of #2265

Description:

  • Add doctest for Average metric

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 the module: metrics Metrics module label Oct 19, 2021
@wanjuntham
Copy link
Author

Hi @ydcjeff , may I have a little guidance on how you achieve #2241 ? I am really new to this repo/package, and I am not sure what are the objects/variables required to execute Average.

@ydcjeff
Copy link
Contributor

ydcjeff commented Oct 19, 2021

Hi @wanjuntham I have updated the contributing guide in #2278 and you can read the rendered docs here.

Basically, you need to

  1. define some dummy engine and data
  2. attach the metrics to the engine and run the engine
  3. get the computed metrics and test with the result in .. testoutput::.

@wanjuntham wanjuntham marked this pull request as draft October 19, 2021 07:22
@sdesrozis
Copy link
Contributor

@wanjuntham Thank you for your interest. Are you still working on this PR ?

@wanjuntham
Copy link
Author

@wanjuntham Thank you for your interest. Are you still working on this PR ?

Hey, I am sorry that I didnt have time to work on this. Please unassign me from the issue.

@wanjuntham wanjuntham closed this Nov 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
module: metrics Metrics module
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants