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

[Doc] Updating documentation: Running the test multiple times #23

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

yannicks1
Copy link
Contributor

[Doc] Updating documentation: Running the test multiple times

This PR improves the section 'Running the test multiple times' in the readme and documentation. The current description is confusing and can be understood wrong:

import pyRAPL

  pyRAPL.setup()
	
  @pyRAPL.measureit(number=100)
  def foo():
      # Instructions to be evaluated.

  for _ in range(100):
      foo()

This code executes 100 experiments with 100 runs each, and does not only average over 100 runs as described.

In order to make things more clear, this commit changes the number of experiments to 20 and updates the description by distinguishing between runs and experiments.

@yannicks1
Copy link
Contributor Author

Could anyone review and merge, @altor @chakib-belgaid @rouvoy @iivanoo ,thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant