Skip to content

Types

Define the types of the analyses: inputs that only the analyses read, and the ReservoirPy node they drive.

ReservoirNodeProtocol

Bases: Protocol

Node of ReservoirPy, imported on first use, as the reservoir step reads it: a reservoir or a ridge readout.

fit(x, y)

Fit the node to inputs and targets.

Source code in src/skcomplex/core/analysis/types.py 
46
47
def fit(self, x: Array, y: Array) -> object:
    """Fit the node to inputs and targets."""

initialize(x)

Initialize the node for inputs of the shape of an example.

Source code in src/skcomplex/core/analysis/types.py 
37
38
def initialize(self, x: Array) -> None:
    """Initialize the node for inputs of the shape of an example."""

run(x)

Return the outputs of the node driven by a series of inputs.

Source code in src/skcomplex/core/analysis/types.py 
40
41
def run(self, x: Array) -> npt.ArrayLike:
    """Return the outputs of the node driven by a series of inputs."""

step(x)

Return the output of the node after one input.

Source code in src/skcomplex/core/analysis/types.py 
43
44
def step(self, x: Array) -> npt.ArrayLike:
    """Return the output of the node after one input."""