onyxengine.data

The OnyxDataset is just a pandas DataFrame with some additional metadata for tracking in the Engine.

class onyxengine.data.OnyxDataset(features: ~typing.List[str] | None = [], dataframe: ~pandas.core.frame.DataFrame = Empty DataFrame Columns: [] Index: [], num_outputs: int = 0, num_state: int = 0, num_control: int = 0, dt: float = 0, config: ~onyxengine.data.dataset.OnyxDatasetConfig | None = None)[source]

Onyx dataset class for storing dataframe and metadata for the dataset. Can be initialized with a configuration object or by parameter.

Parameters:

  • features (List[str]) – List of feature names.

  • dataframe (pd.DataFrame) – Dataframe containing the dataset.

  • num_outputs (int) – Number of output variables.

  • num_state (int) – Number of state variables.

  • num_control (int) – Number of control variables.

  • dt (float) – Time step of the dataset.

  • config (OnyxDatasetConfig) – Configuration object for the dataset. (Optional if other parameters are provided)