quantum/optimize-later
1
0
Fork 0
mirror of https://github.com/quantum5/optimize-later.git synced 2025-04-24 12:32:04 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Quantum 2017-08-15 02:09:35 -04:00 committed by GitHub
parent c2ff12a3e9
commit 7a628f734e
1 changed files with 21 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
README.md
View file

@ -16,13 +16,30 @@ from both the evils of premature optimization, and the evils of slow code.
## Usage ## Usage
```python ```python
from optimize_later import optimize_later from optimize_later import optimize_later, register_callback
### Basic usage. These examples will call your global callback. ### Basic usage.
with optimize_later('test_block', 0.2): with optimize_later('test_block', 0.2):
# potentially slow block of code... # potentially slow block of code...
time.sleep(1) time.sleep(1)
@register_callback
def my_report_function(report):
# Short one line description.
print(report.short())
# Long description with breakdown based on blocks.
print(report.long())
# Details available in:
# - report.name: block name
# - report.limit: time limit
# - report.delta: time consumed
# - report.blocks: breakdown by blocks
# - report.start, report.end: start and end time with an unspecified timer:
# useful for building a relative timeline with blocks.
### More advanced uses.
# Automatic block names from file and source line (slightly slow). # Automatic block names from file and source line (slightly slow).
with optimize_later(0.2): with optimize_later(0.2):
# potentially slow block of code... # potentially slow block of code...
@ -61,24 +78,8 @@ with optimize_later() as o:
with b.block(): with b.block():
pass pass
### Callbacks. ### Callbacks deregistration and contexts.
from optimize_later import register_callback, deregister_callback, optimize_context from optimize_later import deregister_callback, optimize_context
@register_callback
def my_report_function(report):
# Short one line description.
print(report.short())
# Long description with breakdown based on blocks.
print(report.long())
# Details available in:
# - report.name: block name
# - report.limit: time limit
# - report.delta: time consumed
# - report.blocks: breakdown by blocks
# - report.start, report.end: start and end time with an unspecified timer:
# useful for building a relative timeline with blocks.
deregister_callback(my_report_function) deregister_callback(my_report_function)