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

Benchmark reports #2

Open
wants to merge 21 commits into
base: main
Choose a base branch
from
Open

Benchmark reports #2

wants to merge 21 commits into from

Conversation

segsell
Copy link
Member

@segsell segsell commented Apr 19, 2023

Use pytask and sphinx to create an auto-generated webpage with dynamically generated toctree that contains the following information:

  • Profile and deviation plots
  • Convergence report table
  • Rank report table
  • Tracebacks, grouped by scenario
  • Convergence plots of all problems that have not been

To get back to the index page, simply click the left arrow at the bottom.

@segsell segsell requested a review from timmens April 21, 2023 16:41
@timmens
Copy link
Member

timmens commented Apr 21, 2023

Note: We can access the index page by clicking the left arrow.

Copy link
Member

@janosg janosg left a comment

Choose a reason for hiding this comment

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

  • We should not re-create the plots but simply copy them into the directory where we need them. Something like I do for the slides in my current PR.
  • For each report (trancebacks, ranks, convergence), there should be a public function with a similar interface as the profile_plot and convergence_plot in estimagic. I.e. those functions take results and problems and internally call process_benchmark_results. Since we don't have time pressure, those functions can be moved to estimagic right away. Those functions should also have default values for parameters that are in line with the plotting functions. That way we can probably also have a more concise plot_config.

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.

3 participants