diff --git a/docs/source/changes.rst b/docs/source/changes.rst index 4de9d4a3..a3672e78 100644 --- a/docs/source/changes.rst +++ b/docs/source/changes.rst @@ -7,6 +7,12 @@ all releases are available on `PyPI `_ and `Anaconda.org `_. +0.1.6 - 2022-xx-xx +------------------ + +- :gh:`191` adds a guide on how to profile pytask to the developer's guide. + + 0.1.5 - 2022-01-10 ------------------ diff --git a/docs/source/developers_guide.rst b/docs/source/developers_guide.rst index 11be59c4..9551dee7 100644 --- a/docs/source/developers_guide.rst +++ b/docs/source/developers_guide.rst @@ -37,3 +37,22 @@ Creating showcases on the command line .. code-block:: console $ $Host.UI.RawUI.WindowTitle = $title + + +Profiling the application +------------------------- + +To profile pytask, you can follow this `video +`_ (it also features explanations for ``git +bisect``, caching, and profiling tools). We use :mod:`cProfile` with + +.. code-block:: console + + $ python -m cProfile -o log.pstats pytask directory/with/tasks + +The profile can be visualized with + +.. code-block:: console + + $ pip install yelp-gprof2dot + $ gprof2dot log.pstats | dot -T svg -o out.svg