Skip to content
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
update docstring
  • Loading branch information
rokroskar committed Apr 6, 2017
commit ae2a5eb24bd5f92a9e29e46c61027bc4796e58ae
15 changes: 12 additions & 3 deletions memory_profiler.py
Original file line number Diff line number Diff line change
Expand Up @@ -1215,7 +1215,7 @@ def read_mprofile_file(filename):
"""Read an mprofile file and return its content.

Returns
=======
-------
content: dict
Keys:

Expand Down Expand Up @@ -1272,7 +1272,7 @@ def read_mprofile_file_multiprocess(filename):
"""Read an mprofile file and return a mem_usage list

Returns
=======
-------
content: list

This is analogous to the list obtained when the `memory_usage` is used
Expand Down Expand Up @@ -1304,8 +1304,17 @@ def read_mprofile_file_multiprocess(filename):
def convert_mem_usage_to_df(filename, is_pickle=False):
"""Convert a `mem_usage` list to a `pandas.DataFrame`

Parameters
----------
filename: path to the memory profile data; can be either a file
created by mprof or a pickle of the result of `memory_usage`

is_pickle: if True, assume the data is the pickled list
returned by `memory_usage`


Returns
=======
-------
content: pandas.DataFrame

Returns a `pandas.DataFrame` with child IDs as columns and the timestamp as an index
Expand Down