Skip to content

API Reference

Welcome to the API documentation! Here you'll find everything you need to know about Envrax's classes, methods and functionality.

For flexibility, we've organised the reference by category, each covering a distinct part of the API surface.

Here's a quick overview:

  • Environments - the core building blocks for defining and running RL environments. Here you'll find the base classes for building your own environments, how to vectorise them and the classes used for managing multiple at once!
  • Spaces - the specifications/contracts for describing observation and action domains, including the well known Discrete and Box spaces from the Gymnasium [] API.
  • Wrappers - composable transformations that modify environment behaviour. Looking to build your own? Explore the base classes and their type variables! Otherwise, check out the existing stateless pass-through wrappers and stateful variants that Envrax has to offer!
  • Environment Registry - methods for publishing and looking up environments by ID. One registry, unlimited potential. Use the suite types here to easily group related environments together for greater navigation across different suites!
  • Make Methods - canonical factory functions for instantiating environments from registered IDs.
  • Error Handling - custom exceptions raised by Envrax.

Unsure Where to Start?