X-Git-Url: https://www.fleuret.org/cgi-bin/gitweb/gitweb.cgi?a=blobdiff_plain;f=README.md;h=0e8bd5f0f339504a11ae02a0d902e0c549bc4474;hb=384ad9105a3aa81e444141312b7194762f0abb51;hp=193434571dfdf3dbcc8ce353b1dbd59c004e6fe1;hpb=6b672dde68f8a5755221f5126dc350154fa785ad;p=profiler-torch.git

diff --git a/README.md b/README.md
index 1934345..0e8bd5f 100644
--- 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 not provided, the total at the top is used.
 
---
-Francois Fleuret
-Dec 5th, 2016
+Non-Containers are hilighted with a '*' or in red.