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

MAINT: Speed up doc build #12040

Merged
merged 2 commits into from
Oct 1, 2023
Merged

MAINT: Speed up doc build #12040

merged 2 commits into from
Oct 1, 2023

Conversation

larsoner
Copy link
Member

@larsoner larsoner commented Oct 1, 2023

Closes #12012

I changed the examples from that issue that I could. I spent a decent amount of time on the others but couldn't improve their times and/or memory usages.

@larsoner
Copy link
Member Author

larsoner commented Oct 1, 2023

Based on main and PR timings, looks like we got:

  • examples/inverse/dics_epochs.py: 02:28.522, 1533.7 MB to 00:38.96, 1492.3 MB
  • tutorials/intro/70_report.py: 01:27.978, 226.5 MB to 00:62.06, 720.6 MB
  • tutorials/stats-sensor-space/75_cluster_ftest_spatiotemporal.py: 01:18.232, 129.3 MB to 00:33.66, 129.6 MB

Comparing the renderings they look okay to me as well. Ready for review/merge from my end!

report.parse_folder(
data_path, pattern=pattern, render_bem=False, n_time_points_evokeds=5
)
report.save("report_parse_folder_cov.html", overwrite=True)
Copy link
Member

Choose a reason for hiding this comment

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

why removing this?

Copy link
Member Author

@larsoner larsoner Oct 1, 2023

Choose a reason for hiding this comment

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

There is already a section on noise cov viz above. The point is already made elsewhere that parse_folder is cool and usable. So what this adds is explanation of what I'd consider a rare enough use case to omit.

I feel like explaining so many options and configurations can actually be a detriment sometimes. This tutorial webpage is quite long so I think condensing is useful. I was tempted to further roll add_raw/events/epochs/evoked/cov into a "sensor" block/report and add_bem/fwd/inv/stc into a "source" report rather than generating 9 separate reports for these for example. But that seemed a bit drastic and wouldn't speed things up anyway...

Copy link
Member

Choose a reason for hiding this comment

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

👌

@larsoner larsoner enabled auto-merge (squash) October 1, 2023 21:57
@larsoner larsoner merged commit 110947f into mne-tools:main Oct 1, 2023
28 checks passed
@larsoner larsoner deleted the doctime branch October 2, 2023 09:35
@larsoner larsoner added the MAINT label Oct 2, 2023
snwnde pushed a commit to snwnde/mne-python that referenced this pull request Mar 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

MAINT: Decrease doc build time
2 participants