diff --git a/.gitignore b/.gitignore index 7499b52..5200c61 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,6 @@ MANIFEST *.egg-info *.pyc *~ + +# Ignore mprof generated files +mprofile_*.dat diff --git a/README.rst b/README.rst index 1cbfee1..84947a7 100644 --- a/README.rst +++ b/README.rst @@ -107,10 +107,10 @@ decorator function. Use as follows:: del b return a -If a python script with decorator ``@profile`` is called using ``-m +If a python script with decorator ``@profile`` is called using ``-m memory_profiler`` in the command line, the ``precision`` parameter is ignored. -Time-based memory usage +Time-based memory usage ========================== Sometimes it is useful to have full memory usage reports as a function of time (not line-by-line) of external processes (be it Python scripts or not). @@ -131,14 +131,14 @@ e.g. `mprof run -h`. In the case of a Python script, using the previous command does not give you any information on which function is executed at a given time. Depending on the case, it can be difficult to identify the part -of the code that is causing the highest memory usage. +of the code that is causing the highest memory usage. Adding the `profile` decorator to a function and running the Python -script with +script with mprof run