onyxengine.data

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

class onyxengine.data.OnyxDataset(dataframe=pd.DataFrame(), features=[], dt=0, config=None)[source]

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

Parameters:

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

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

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

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

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

  • features (List[str] | None)