citylearn.internal.loading module

class citylearn.internal.loading.CityLearnLoadingService(env: CityLearnEnv)[source]

Bases: object

Internal loader service that builds env components from schema.

load(schema: Mapping[str, Any], **kwargs) → Tuple[PathLike | str, List[Building], List[ElectricVehicle], int | List[Tuple[int, int]], bool, bool, float, RewardFunction, bool, List[str], EpisodeTracker][source]: Return env objects as defined by schema.

load_building(index: int, building_name: str, schema: dict, episode_tracker: EpisodeTracker, pv_sizing_data: DataFrame, battery_sizing_data: DataFrame, **kwargs) → Building[source]: Initialize and return a building model.

load_electric_vehicle(electric_vehicle_name: str, schema: dict, electric_vehicle_schema: dict, episode_tracker: EpisodeTracker, time_step_ratio) → ElectricVehicle[source]: Initialize and return an electric vehicle model.

load_washing_machine(washing_machine_name: str, schema: dict, washing_machine_schema: dict, episode_tracker: EpisodeTracker) → WashingMachine[source]: Load simulation data and initialize a WashingMachine instance.

process_metadata(schema, building_schema, chargers_list, washing_machines_list, index, energy_simulation: EnergySimulation, **kwargs)[source]: Build observation and action metadata for one building.

class citylearn.internal.loading.LoadContext(schema: Mapping[str, Any], kwargs: Mapping[str, Any])[source]

Bases: object

Lightweight holder for loading inputs.