incremental

Stepable

Bases: Protocol

Base class for stepable environments.

Stepable environments are environments that can be advanced by a step. Usually, this is combined with an observable to provide a stream of data.

step() abstractmethod

Advance the environment by one step.

Source code in src/flowcean/core/environment/incremental.py

@abstractmethod
def step(self) -> None:
    """Advance the environment by one step."""

Finished

Bases: Exception

Exception raised when the environment is finished.

This exception is raised when the environment is finished, and no more data can be retrieved.

IncrementalEnvironment

Bases: Environment, Stepable, Iterable[Data], Protocol

An environment providing incremental (streaming) learning data.

Incremental environments provide data as a continuous stream of samples or small batches. The environment is advanced by stepping through data, observing the current state at each step. This supports incremental learning (also known as passive online learning), where the model is continuously updated as new data arrives.

num_steps()

Return the number of steps in the environment.

Returns:

Type	Description
int | None	The number of steps in the environment, or None if the number of
int | None	steps is unknown.

Source code in src/flowcean/core/environment/incremental.py

def num_steps(self) -> int | None:
    """Return the number of steps in the environment.

    Returns:
        The number of steps in the environment, or None if the number of
        steps is unknown.
    """
    return None