Skip to content

MRG: Add timing information #348

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

Merged
merged 4 commits into from
Nov 15, 2018
Merged

Conversation

larsoner
Copy link
Contributor

@larsoner larsoner commented Feb 9, 2018

Closes #203.

Todo:

  • Add total computation time at the top
  • Make it prettier (table?)

@codecov-io
Copy link

codecov-io commented Feb 9, 2018

Codecov Report

Merging #348 into master will decrease coverage by <.01%.
The diff coverage is 95.45%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #348      +/-   ##
==========================================
- Coverage   95.51%   95.51%   -0.01%     
==========================================
  Files          29       29              
  Lines        2252     2274      +22     
==========================================
+ Hits         2151     2172      +21     
- Misses        101      102       +1
Impacted Files Coverage Δ
sphinx_gallery/tests/test_full.py 100% <100%> (ø) ⬆️
sphinx_gallery/gen_gallery.py 88.79% <94.44%> (+0.45%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update abe8765...06912d5. Read the comment docs.

@larsoner
Copy link
Contributor Author

larsoner commented Feb 9, 2018

@GaelVaroquaux I think this is what you were asking for in #203 (I agree it would be useful in MNE). Feel free to take over to tweak the ReST to taste if you have time (you can push directly to my branch assuming you can as a SG maintainer), or comment here and I can do it. This is what it looks like:

https://370-25860190-gh.circle-artifacts.com/0/home/ubuntu/sphinx-gallery/doc/_build/html/auto_examples/sg_execution_times.html

It's not the most beautiful thing in the world -- maybe it should be a table. It should probably also show the total computation time, now that I think about it.

I haven't linked to it from examples or anywhere else because I consider this summary a "maintainer tool" more than something users would be interested in, given that they can see per-example timings already.

@lesteve lesteve force-pushed the master branch 3 times, most recently from 0c1f0d4 to 49d4f11 Compare June 13, 2018 18:18
@larsoner larsoner changed the title WIP: Add timing information MRG: Add timing information Nov 14, 2018
@larsoner larsoner added this to the v0.3.0 milestone Nov 14, 2018
@larsoner
Copy link
Contributor Author

Let's just get this one in and we can make it prettier later. It's mostly an advanced option for devs anyway. There is now a link to it in the configuration page to note its existence. For us it looks pretty trivial:

https://635-25860190-gh.circle-artifacts.com/0/html/auto_examples/sg_execution_times.html#sphx-glr-auto-examples-sg-execution-times

Should be ready for merge for 0.3.

@choldgraf
Copy link
Contributor

choldgraf commented Nov 14, 2018

LGTM - that's a nifty feature! +1 when travis is happy

@larsoner
Copy link
Contributor Author

Tweaked to include total for the directory

https://646-25860190-gh.circle-artifacts.com/0/html/auto_examples/sg_execution_times.html

@choldgraf feel free to merge if you are happy

@choldgraf choldgraf merged commit 29aba7f into sphinx-gallery:master Nov 15, 2018
@choldgraf
Copy link
Contributor

cool - nice patch! 🎉

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