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

ENH: get timing info for notebooks/cells #326

Open
bsipocz opened this issue Aug 28, 2024 · 5 comments
Open

ENH: get timing info for notebooks/cells #326

bsipocz opened this issue Aug 28, 2024 · 5 comments
Labels
enhancement New feature or request infrastructure Issues about the infrastructure rather than content of the notebooks

Comments

@bsipocz
Copy link
Member

bsipocz commented Aug 28, 2024

Currently, we don't use pytest, but it would be nice to find a way to run --durations type stats on the notebooks with nb execution, too. It would help to pin down bottlenecks such as #324

@bsipocz bsipocz added enhancement New feature or request infrastructure Issues about the infrastructure rather than content of the notebooks labels Aug 28, 2024
@bsipocz
Copy link
Member Author

bsipocz commented Sep 20, 2024

Note there is: https://myst-nb.readthedocs.io/en/latest/computation/execute.html#execution-statistics, we just need to figure but it doesn't go into the cell level detail as pytest do; and the notebook level timing info is already in the log (though of course having a nicely rendered table could be useful, too)

@jkrick
Copy link
Contributor

jkrick commented Sep 20, 2024

We had also talked about having the notebook timing info as a part of the intro to the notebooks so users would know how long to expect the notebook to take to run. Is this info, from either myst or pytest, able to be fed back into the text? Or is that dreaming?

@bsipocz
Copy link
Member Author

bsipocz commented Sep 20, 2024

This is more about ci and benchmarking on the code cell level, but actual user expected FSC timing info somewhere in the top description would be nice, too.

@bsipocz
Copy link
Member Author

bsipocz commented Sep 20, 2024

Is this info, from either myst or pytest, able to be fed back into the text? Or is that dreaming?

The total runtime can be easily harvested from the logs, see the link above for an example, but I don't think that would be particularly useful for the users as the resources we use in CI are much different, especially as we're thinking about stupidifying some of the cells for CI.

@jkrick
Copy link
Contributor

jkrick commented Sep 20, 2024

good point about different resources.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request infrastructure Issues about the infrastructure rather than content of the notebooks
Projects
None yet
Development

No branches or pull requests

2 participants