diff --git a/.doctrees/autoapi/lasdi/timing/index.doctree b/.doctrees/autoapi/lasdi/timing/index.doctree index c0a0c34..a87ade8 100644 Binary files a/.doctrees/autoapi/lasdi/timing/index.doctree and b/.doctrees/autoapi/lasdi/timing/index.doctree differ diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle index 8ce5ac0..882d936 100644 Binary files a/.doctrees/environment.pickle and b/.doctrees/environment.pickle differ diff --git a/_sources/autoapi/lasdi/timing/index.rst.txt b/_sources/autoapi/lasdi/timing/index.rst.txt index 2f919f9..29846d6 100644 --- a/_sources/autoapi/lasdi/timing/index.rst.txt +++ b/_sources/autoapi/lasdi/timing/index.rst.txt @@ -107,7 +107,30 @@ Module Contents .. py:method:: export() + Export the list of jobs and their number of calls and total time + into a dictionary. + + Note: + All jobs must be ended before calling this method. + + Returns: + :obj:`dict` that contains "names", "calls", and "times" as keys + + .. py:method:: load(dict_) + Load the list of jobs and their number of calls and total time + from a dictionary. + + Args: + `dict_` (:obj:`dict`): Dictionary that contains the list of jobs and their calls and times. + + Note: + :obj:`dict_['names']`, :obj:`dict_['calls']` and :obj:`dict_['times']` must have the same size. + + Returns: + Does not return a value + + diff --git a/autoapi/lasdi/timing/index.html b/autoapi/lasdi/timing/index.html index 2fbf4bb..dce6b1d 100644 --- a/autoapi/lasdi/timing/index.html +++ b/autoapi/lasdi/timing/index.html @@ -200,12 +200,30 @@
Export the list of jobs and their number of calls and total time +into a dictionary.
+All jobs must be ended before calling this method.
+dict
that contains “names”, “calls”, and “times” as keys
Load the list of jobs and their number of calls and total time +from a dictionary.
+dict_ (dict
): Dictionary that contains the list of jobs and their calls and times.
dict_['names']
, dict_['calls']
and dict_['times']
must have the same size.
Does not return a value
+