telar-core/dev.deeptelar.telar/Checkpoint

Checkpoint

data class Checkpoint<State>(val state: State, val nextNodes: List<String>, val step: Int = 0, val interruptedBefore: Boolean = false, val subgraphs: Map<String, SubgraphPosition> = emptyMap())

A saved point in a graph run.

Constructors

Checkpoint

constructor(state: State, nextNodes: List<String>, step: Int = 0, interruptedBefore: Boolean = false, subgraphs: Map<String, SubgraphPosition> = emptyMap())

Properties

interruptedBefore

val interruptedBefore: Boolean

true when the run paused before nextNodes because of GraphConfig.interruptBefore, or because one of them called interrupt when it ran. CompiledGraph.resume then runs those nodes without pausing before them again. A checkpoint saved for any other reason is false, so resuming it still pauses before a node listed in GraphConfig.interruptBefore.

isComplete

val isComplete: Boolean

true when the run reached END and there is nothing left to resume.

nextNodes

val nextNodes: List<String>

the nodes that run when the thread is resumed. Empty when the run completed.

state

val state: State

the graph state after the last executed step, or the input of the run when no step has finished yet.

step

val step: Int

the number of steps the thread has executed so far. 0 for the checkpoint that is saved when a run starts.

subgraphs

val subgraphs: Map<String, SubgraphPosition>

where the run stands inside the subgraphs among nextNodes, by the name of their node. It has an entry for a subgraph that the run paused in, so that CompiledGraph.resume continues inside it. A Checkpointer has to store it with the rest.