diff --git a/doc/source/client-py.rst b/doc/source/client-py.rst index 79ba2644acbe6e2777f78eed41d32c8df4bc9a15..00a7a39ed13abbbbec18a9751ac2242b6e9c172d 100644 --- a/doc/source/client-py.rst +++ b/doc/source/client-py.rst @@ -395,49 +395,29 @@ Reports ------- Reporting system serves for debugging and profiling the Loom programs. -Report can be created by ``submit`` method by the following way:: +Reports can be enabled by ``set_trace`` method as follows:: task = ... - client.submit(task, "myreport.report") + client.set_trace("/path/to/mytrace") + client.submit(task) -It creates report file `myreport.report`. This file can be explored by ``loom.rview``. +The path provided to ``set_trace`` has to be placed on a network filesystem that +is visible to server and all workers. It creates a directory +``/path/to/mytrace`` where server and workers writes its traces. -The following command shows graph of the plan: +The trace can be explored by ``loom.lore``. :: - $ python3 -m loom.rview myreport.report --show-graph - -The following command shows tracelog of tasks (how long and where each tasks was -executed): - -:: - - $ python3 -m loom.rview myreport.report --show-trace - - -The following command generates summary plan execution report in HTML: - -:: - - $ python3 -m loom.rview myreport.report --html-report - + $ python3 -m loom.lore /path/to/mytrace +It creates file *output.html* that contains the final report. The full list of commands can be obtained by :: $ python3 -m loom.rview --help -In the example above, we have created report by ``submit``. It is possible to -create a report without submitting a task by -:py:func:`loom.client.make_dry_report`. The report created by this way contains -a graph of tasks, but does not contain runtime information (since the task was -not executed):: - - from loom.client import make_dry_report - task = ... - make_dry_report(task, "myreport.report") Labels ------ diff --git a/doc/source/conf.py b/doc/source/conf.py index 4f5a2b5b7f55682c89516b6ac4e4d22fc04c24ab..8e3f48e16043cc651f91714bdcc63693e6c564a0 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -64,9 +64,9 @@ author = u'Loom Team' # built documents. # # The short X.Y version. -version = u'0.4' +version = u'0.6' # The full version, including alpha/beta/rc tags. -release = u'0.2' +release = u'0.6' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.