Skip to main content

Results

Collecting and managing results

covalent.get_result(dispatch_id, wait=False, dispatcher_addr=None, status_only=False)​

Get the results of a dispatch from the Covalent server.

PARAMETERS

  • dispatch_id (str) – The dispatch id of the result.
  • wait (bool) – Controls how long the method waits for the server to return a result. If False, the method will not wait and will return the current status of the workflow. If True, the method will wait for the result to finish and keep retrying for sys.maxsize.
  • dispatcher_addr (Optional[str]) – Dispatcher server address, if None then defaults to the address set in Covalent’s config.
  • status_only (bool) – If true, only returns result status, not the full result object, default is False.

RETURN TYPE

RETURNS

The Result object from the Covalent server

class covalent._results_manager.result.Result(lattice, dispatch_id='')       [source]​

Result class to store and perform operations on the result obtained from a dispatch.

lattice

“Lattice” object which was dispatched.

results_dir

results_dir

dispatch_id

Dispatch id assigned to this dispatch.

root_dispatch_id

Dispatch id of the root lattice in a hierarchy of sublattice workflows.

status

Status of the result. It’ll be one of the following: - Result.NEW_OBJ: When it is a new result object. - Result.COMPLETED: When processing of all the nodes has completed successfully. - Result.RUNNING: When some node executions are in process. - Result.FAILED: When one or more node executions have failed. - Result.CANCELLED: When the dispatch was cancelled.

result

Final result of the dispatch, i.e whatever the “Lattice” was returning as a function.

inputs

Inputs sent to the “Lattice” function for dispatching.

error

Error due to which the execution failed.

Functions:

save_result: Save the result object to the passed results directory or to self.results_dir by default. get_all_node_outputs: Return all the outputs of all the node executions.

Attributes:

 
Dispatch id of current dispatch.
Encoded final result of current dispatch
End time of processing the dispatch.
Error due to which the dispatch failed.
Inputs sent to the “Lattice” function for dispatching.
“Lattice” object which was dispatched.
Final result of current dispatch.
Results directory used to save this result object.
Dispatch id of the root dispatch
Start time of processing the dispatch.
Status of current dispatch.
  

Methods:

Return output of every node execution.
Get all the node results.

get_node_result(node_id)  

Return the result of a particular node.
Post-processing method

property dispatch_id: str​

Dispatch id of current dispatch.

RETURN TYPE

str

property encoded_result: covalent.TransportableObject​

Encoded final result of current dispatch

RETURN TYPE

property end_time: datetime.datetime​

End time of processing the dispatch.

RETURN TYPE

datetime

property error: str​

Error due to which the dispatch failed.

RETURN TYPE

str

get_all_node_outputs()[source]​

Return output of every node execution.

PARAMETERS

None-

RETURNS

A dictionary containing the output of every node execution.

RETURN TYPE

node_outputs

get_all_node_results()[source]​

Get all the node results.

PARAMETERS

None-

RETURNS

A list of dictionaries containing the result of every node execution.

RETURN TYPE

node_results

get_node_result(node_id)[source]​

Return the result of a particular node.

PARAMETERS

node_id (int) – The node id.

RETURNS

The result of the node containing below in a dictionary format:

  • node_id: The node id.
  • node_name: The name of the node.
  • start_time: The start time of the node execution.
  • end_time: The end time of the node execution.
  • status: The status of the node execution.
  • output: The output of the node unless error occured in which case None.
  • error: The error of the node if occured else None.
  • sublattice_result: The result of the sublattice if any.
  • stdout: The stdout of the node execution.
  • stderr: The stderr of the node execution.

RETURN TYPE

node_result

property inputs: dict​

Inputs sent to the “Lattice” function for dispatching.

RETURN TYPE

dict

property lattice: covalent._workflow.lattice.Lattice​

“Lattice” object which was dispatched.

RETURN TYPE

post_process()[source]​

Post-processing method. This method was introduced to enable manual client-side postprocessing in case automatic post-processing by the server fails (e.g. insufficient dask worker memory)

RETURNS

Post-processed result output

RETURN TYPE

Any

property result: Union[int, float, list, dict]​

Final result of current dispatch.

RETURN TYPE

Union[int, float, list, dict]

property results_dir: str​

Results directory used to save this result object.

RETURN TYPE

str

property root_dispatch_id: str​

Dispatch id of the root dispatch

RETURN TYPE

str

property start_time: datetime.datetime​

Start time of processing the dispatch.

RETURN TYPE

datetime

property status: covalent._shared_files.util_classes.Status​

Status of current dispatch.

RETURN TYPE

Status