Python API
The supported API is the set of modules below. Their documented classes, functions and arguments follow the release notes and the migration guide when they change.
Module |
Use it for |
|---|---|
|
|
|
|
Controllers: |
|
Built-in rewards and the |
|
Gymnasium wrappers: normalised and discrete spaces, Stable-Baselines3 and RLlib adapters. |
|
|
|
|
The simulated buildings and devices, for reading their state and series during and after an episode. |
The legacy cost functions behind |
|
The random stream versions selected by |
Other modules are documented for reference but are not a stable interface:
citylearn.utilities and citylearn.utils hold helpers the package uses
itself, and the remaining modules support the classes above.
citylearn.internal holds the environment’s private services. It is not
published here, and it can change in any release without notice.