Added color!

[profiler-torch.git] / README.md

diff --git a/README.md b/README.md
index 1934345..0e851f4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,18 +1,22 @@
 
 This is a simple profiler to estimate processing time per module per function.
 
+It seems to work okay, but there was no heavy testing so far. See test-profiler.lua for a short example.
+
+### profiler.color ###
+
+This is a Boolean flag to state if the printing should be done in color. It is true by default.
+
 ### profiler.decorate(model, [functionsToDecorate]) ###
 
 This function should be called before starting the computation.
 
-t replaces functions specified in functionsToDecorate by instrumented versions which keep track of computation times. If functionsToDecorate is not provided, it decorates by default updateOutput and backward.
+It replaces functions specified in functionsToDecorate by instrumented versions which keep track of computation times. If functionsToDecorate is not provided, it decorates by default updateOutput and backward.
 
-### profiler.print(model, [nbSamples]) ###
+It also resets the accumulated timings to zero.
 
-Prints the measured processing times. If nbSamples is provided, the time per samples will also be printed.
+### profiler.print(model, [nbSamples], [totalTime]) ###
 
-It seems to work okay, but there was no heavy testing so far.
+Prints the measured processing times. If nbSamples is provided, the time per samples will also be printed. If totalTime is provided, the percentages will also be printed.
 
---
-Francois Fleuret
-Dec 5th, 2016
+Non-Containers are hilighted with a '*' or in red.