diff --git a/CHANGES.rst b/CHANGES.rst index 27c85ed83..2a89e47e0 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,6 +1,19 @@ TiMemory ======== +Release: TiMemory 1.1.0 +~~~~~~~~~~~~~~~~~~~~~~~ + +- Author: Jonathan R. Madsen +- Date: Mon Jan 29 15:00:12 2018 -0800 + + - Added 'report_at_exit' parameter to auto_timer decorator + - Added added_args flag for auto_timer decorator + - Fixed I/O output bug + - Added setup.cfg + - Fixed auto_timer decorator issue with self.key, self.is_class, and self.add_args + + Release: TiMemory 1.1b0 ~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/CMakeLists.txt b/CMakeLists.txt index 5e4688734..1b91b235e 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,6 +1,6 @@ cmake_minimum_required(VERSION 3.1.3 FATAL_ERROR) -project(TiMemory LANGUAGES C CXX VERSION 1.1.0) +project(TiMemory LANGUAGES C CXX VERSION 1.1.1) set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR}/cmake/Modules ${CMAKE_MODULE_PATH}) diff --git a/README.md b/README.md index 100342d53..410228457 100644 --- a/README.md +++ b/README.md @@ -56,9 +56,10 @@ python setup.py config --disable-mpi build install - key : this is a custom key to append after function name. The default will add file and line number. - add_args : add the arguments to the auto-timer key. Will be over-ridden by key argument - is_class : will add `'[{}]'.format(type(self).__name__)`` to the function name + - report_at_exit (auto_timer only) : at the end of the timing, report to stdout ```python -@timemory.util.auto_timer(key="", add_args=False, is_class=False) +@timemory.util.auto_timer(key="", add_args=False, is_class=False, report_at_exit=False) def function(...): time.sleep(1) ``` @@ -66,12 +67,12 @@ def function(...): #### Auto-timer example ```python -@timemory.util.auto_timer(key="", add_args=False, is_class=False) +@timemory.util.auto_timer(key="", add_args=False, is_class=False, report_at_exit=False) def function(...): time.sleep(1) ``` - - output (from `timemory.report()`): + - sample of an output (from `timemory.report()`): ``` > [pyc] test_func_glob@'timemory_test.py':218 : 5.003 wall, 0.000 user + 0.000 system = 0.000 CPU [sec] ( 0.0%) : RSS {tot,self}_{curr,peak} : (52.6|52.6) | ( 0.0| 0.0) [MB] @@ -88,7 +89,7 @@ def function(...): time.sleep(1) ``` - - output: + - sample of an output: ``` # free function @@ -105,7 +106,7 @@ def function(...): time.sleep(1) ``` - - output: + - sample of an output: ``` test_func_rss@'timemory_test.py':244 : RSS {total,self}_{current,peak} : (52.536|193.164) | (0.0|140.568) [MB] diff --git a/README.rst b/README.rst index a82d960b9..8648407b2 100644 --- a/README.rst +++ b/README.rst @@ -70,10 +70,12 @@ Basic Python usage over-ridden by key argument - is\_class : will add \`'[{}]'.format(type(self).\ **name**)\`\` to the function name + - report\_at\_exit (auto\_timer only) : at the end of the timing, + report to stdout .. code:: python - @timemory.util.auto_timer(key="", add_args=False, is_class=False) + @timemory.util.auto_timer(key="", add_args=False, is_class=False, report_at_exit=False) def function(...): time.sleep(1) @@ -82,13 +84,13 @@ Auto-timer example .. code:: python - @timemory.util.auto_timer(key="", add_args=False, is_class=False) + @timemory.util.auto_timer(key="", add_args=False, is_class=False, report_at_exit=False) def function(...): time.sleep(1) :: - - output (from `timemory.report()`): + - sample of an output (from `timemory.report()`): :: @@ -108,7 +110,7 @@ Timer example (will report to stdout at the end of the function) :: - - output: + - sample of an output: :: @@ -128,7 +130,7 @@ RSS usage example: :: - - output: + - sample of an output: :: diff --git a/docs/annotated.html b/docs/annotated.html index 5e7b7b97e..bb0b97cdc 100644 --- a/docs/annotated.html +++ b/docs/annotated.html @@ -29,7 +29,7 @@
TiMemory -  1.1.0 +  1.1.1
C++ and Python Timing and Memory Tracking
@@ -140,7 +140,7 @@
The documentation for this class was generated from the following file: