search

bloomberg / memray

Memray is a memory profiler for Python
https://bloomberg.github.io/memray/
Apache License 2.0
13.36k stars 397 forks source link

Intro Level Tutorial #590

Closed jcarnaxide closed 5 months ago

jcarnaxide commented 6 months ago

Issue number of the reported bug or feature request: #

Describe your changes We have worked on an introductory level course for people to get familiar with Memray.

Testing performed We ran make docs-live to view the new RST files, and to see everything is rendered properly. We also ran the exercises via instructions specified and was able to get through the whole tutorial.

Additional context It is worth noting, that I plan to update the instructions to include running the tutorial via codespaces, but we stuck with simple venv/pip for this first PR.

jcarnaxide commented 6 months ago

@godlygeek I have addressed your comments for restructuring, as well as combining the introduction to the tutorials. @statkute please have a look at the changes I have made.

I think we should still update the rst page for additional features inside the tutorials directory.

codecov-commenter commented 6 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 92.70%. Comparing base (41248ed) to head (8bd476d). Report is 42 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #590 +/- ## ========================================== + Coverage 92.55% 92.70% +0.14% ========================================== Files 91 92 +1 Lines 11304 11234 -70 Branches 1581 2055 +474 ========================================== - Hits 10462 10414 -48 + Misses 837 820 -17 + Partials 5 0 -5 ``` | [Flag](https://app.codecov.io/gh/bloomberg/memray/pull/590/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg) | Coverage Δ | | |---|---|---| | [cpp](https://app.codecov.io/gh/bloomberg/memray/pull/590/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg) | `92.70% <ø> (+6.76%)` | :arrow_up: | | [python_and_cython](https://app.codecov.io/gh/bloomberg/memray/pull/590/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg) | `92.70% <ø> (-3.02%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

statkute commented 6 months ago

@godlygeek I have addressed your comments for restructuring, as well as combining the introduction to the tutorials. @statkute please have a look at the changes I have made.

I think we should still update the rst page for additional features inside the tutorials directory.

I've now updated a couple internal links that stopped working due to the new tutorials/ directory. Otherwise looks great-- thanks for the fixes while I was out @jcarnaxide !

I've also added a brief section that encourages to explore the Concepts section after finishing the hands-on tutorial (under additional features).

@godlygeek we should be good for another look whenever you have the time -- thank you!