Skip to content

Timing and information

Romain Mormont edited this page Nov 29, 2017 · 3 revisions

Executing a workflow (or a chain) generates some information. Those information are organized in objects of type WorkflowInformation (and ChainInformation).

# executing a workflow generates a WorkflowInformation object
workflow_info = workflow.process(image)

# executing a chain generates a ChainInformation object
chain_info = chain.process(image)

WorkflowInformation

The WorkflowInformation object gather information about the detected objects and the execution. Objects and their metadata can be iterated:

object_info = workflow.process(image)
for object_info in workflow_info:
    print(object_info.polygon)
    print(object_info.label)

Information about execution times can also be fetched through the timing field which returns a WorkflowTiming object. Each type of workflow has its own metadata which are described in the "Workflows" page.

ChainInformation

A ChainInformation object stores a WorkflowInformation object for each workflow the chain uses. Every object can be fetched using the step label.

WorkflowTiming

The WorkflowTiming contains timing information about every step of the algorithm and provide some methods to summarize and report those timings.

Clone this wiki locally