Skip to main content

StepResult

One session's outcome of an iterate step: keep stepping (Continue), done (Finish), or failed (Error), with this step's outputs for the session.

disposition (property)​

(self) -> clika_runtime._core.runtime.Disposition

error (property)​

The failure message when the disposition is Error, else None.

outputs (property)​

This step's outputs for the session, as a dict of tensors.

__init__​

__init____init__(self, disposition: clika_runtime._core.runtime.Disposition = Disposition.Continue, *, outputs: dict | None = None, error: str | None = None) -> None

init(self, disposition: clika_runtime._core.runtime.Disposition = Disposition.Continue, *, outputs: dict | None = None, error: str | None = None) -> None

outputs is a dict of tensors keyed by the node's output names; an error message sets the disposition to Error.

fail​

fail(*args, **kwargs)

fail(message: str) -> clika_runtime._core.runtime.StepResult

An Error result: this session fails with message; the rest of the batch is undisturbed.

finish​

finish(*args, **kwargs)

finish(outputs: dict | None = None) -> clika_runtime._core.runtime.StepResult

A Finish result carrying the session's final outputs.