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

Add guidance on using profilers from within Jupyter notebooks. #24

Merged
merged 5 commits into from
Mar 22, 2024

Conversation

Robadob
Copy link
Member

@Robadob Robadob commented Mar 22, 2024

I've included notebook copies of the two worked examples, but have opted against linking them from the relevant episodes.

Notebook code blocks are marked as py, doesn't appear the markdown engine supports ipynb type.

Closes #23

@Robadob Robadob requested a review from ns-rse March 22, 2024 14:08
@Robadob Robadob self-assigned this Mar 22, 2024
Copy link

github-actions bot commented Mar 22, 2024

🆗 Pre-flight checks passed 😃

This pull request has been checked and contains no modified workflow files or spoofing.

Results of any additional workflows will appear here when they are done.

github-actions bot pushed a commit that referenced this pull request Mar 22, 2024
Copy link

@ns-rse ns-rse left a comment

Choose a reason for hiding this comment

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

Some minor suggestions but looks good, succinctly shows users how to apply both function and line profiling to their work in Notebooks. 👍

episodes/profiling-functions.md Outdated Show resolved Hide resolved
episodes/profiling-functions.md Outdated Show resolved Hide resolved
episodes/profiling-functions.md Outdated Show resolved Hide resolved
episodes/profiling-lines.md Outdated Show resolved Hide resolved
github-actions bot pushed a commit that referenced this pull request Mar 22, 2024
@Robadob
Copy link
Member Author

Robadob commented Mar 22, 2024

Thanks for the feedback @ns-rse, really useful.

Manually actioned the first, and had to tweak the suggestion for the last. But all were used.

@Robadob Robadob merged commit f2233ca into main Mar 22, 2024
3 checks passed
@Robadob Robadob deleted the notebook_profiling branch March 22, 2024 15:25
github-actions bot pushed a commit that referenced this pull request Mar 22, 2024
Auto-generated via {sandpaper}
Source  : f2233ca
Branch  : main
Author  : Robert Chisholm <[email protected]>
Time    : 2024-03-22 15:25:12 +0000
Message : Add guidance on using profilers from within Jupyter notebooks. (#24)

Co-authored-by: Neil Shephard <[email protected]>
Closes #23
github-actions bot pushed a commit that referenced this pull request Mar 22, 2024
Auto-generated via {sandpaper}
Source  : 6e47732
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-03-22 15:27:20 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : f2233ca
Branch  : main
Author  : Robert Chisholm <[email protected]>
Time    : 2024-03-22 15:25:12 +0000
Message : Add guidance on using profilers from within Jupyter notebooks. (#24)

Co-authored-by: Neil Shephard <[email protected]>
Closes #23
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.

Notebook profiling
2 participants