Ctrl+K

ostatslib.states.state#

State module

Classes

State([data_features, analysis_features, ...])

State class
class State(data_features: ostatslib.states.data_features_set.DataFeaturesSet | None = None, analysis_features: ostatslib.states.analysis_features_set.AnalysisFeaturesSet | None = None, models_features: ostatslib.states.models_features_set.ModelsFeaturesSet | None = None)[source]#

State class

property as_gymnasium_space: Dict#

Returns Gymnasium space Dict https://gymnasium.farama.org/api/spaces/composite/#dict

Returns:

Gymnasium space Dict

Return type:

Dict

copy() → State[source]#

Deep copies State instance

Returns:

state instance deep copy

Return type:

State

property features_dict: dict[str, float | int | bool]#

Returns features dictionary

Returns:

array of values

Return type:

ndarray

property features_vector: ndarray[float]#

Returns features vector

Returns:

array of values

Return type:

ndarray

get(feature_key: str) → str | int | float | bool[source]#

Gets feature value by passing feature key (feature name). If feature is not found, returns NaN.

Parameters:

feature_key (str) – feature key (name)

Raises:

AttributeError – raises error if feature is not found

Returns:

feature value

Return type:

str | int | float | bool

property keys: tuple[str]#

Returns features keys (names)

Returns:

list of features keys (names)

Return type:

list[str]

list_known_features() → list[tuple[str, float | int | str]][source]#

Lists fields that have values different from default (unknown state attribute)

Returns:

list of non-default values

Return type:

KnownFeaturesList

set(feature_key: str, value: str | int | float | bool) → None[source]#

Sets value to feature

Parameters:

  • feature_key (str) – feature key (name)

  • value (str | int | float | bool) – value

Raises:

AttributeError – If feature is not found

Show Source