Skip to main content

Unified robot environment framework supporting multiple tensor and simulation backends

Project description

UniEnv

Framework unifying robot environments and data APIs. UniEnv provides an universal interface for robot actors, sensors, environments, and data.

Tensor library cross-backend Support

UniEnv supports multiple tensor backends with zero-copy translation layers through the DLPack protocol, and allows you to use the same abstract compute backend interface to write custom data transformation layers, environment wrappers and other utilities. This is powered by the XBArray package.

Universal Robot Environment Interface

UniEnv supports diverse simulation environments and real robots, built on top of the abstract environment / world interface. This allows you to reuse code across different sim and real robots.

Universal Robot Data Interface

UniEnv provides a universal data interface for accessing robot data through the abstract BatchBase interface. We also provide a utility ReplayBuffer for saving data from various environments with diverse data format support, including hdf5, memory-mapped torch tensors, and others.

Installation

Install the package with pip

pip install unienv

You can install optional dependencies such as gymnasium (for Gymnasium-compatible environments), dev, or video by running

pip install unienv[gymnasium,video]

Cite

If you use UniEnv in your research, please cite it as follows:

@software{cao_unienv,
  author = {Cao, Yunhao AND Fang, Kuan},
  title = {{UniEnv: Unifying Robot Environments and Data APIs}},
  year = {2025},
  month = oct,
  url = {https://github.com/UniEnvOrg/UniEnv},
  license = {MIT}
}

Acknowledgements

The idea of this project is inspired by Gymnasium and its predecessor OpenAI Gym. This library is impossible without the great work of DataAPIs Consortium and their work on the Array API Standard. The zero-copy translation layers are powered by the DLPack project.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

unienv-0.0.1b3.tar.gz (88.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

unienv-0.0.1b3-py3-none-any.whl (134.2 kB view details)

Uploaded Python 3

File details

Details for the file unienv-0.0.1b3.tar.gz.

File metadata

  • Download URL: unienv-0.0.1b3.tar.gz
  • Upload date:
  • Size: 88.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for unienv-0.0.1b3.tar.gz
Algorithm Hash digest
SHA256 252842c97c7b971ac266654f73d92e5ff3cb460b5af8536803b4ba7a132617fb
MD5 1c101d2c881eb612733bea213d9fcde8
BLAKE2b-256 7e5f8e31f11b145feaae516dda4c627a3064021cb938a9ece60c0a23372d8ece

See more details on using hashes here.

File details

Details for the file unienv-0.0.1b3-py3-none-any.whl.

File metadata

  • Download URL: unienv-0.0.1b3-py3-none-any.whl
  • Upload date:
  • Size: 134.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for unienv-0.0.1b3-py3-none-any.whl
Algorithm Hash digest
SHA256 15ce720354caa7082365f259576e752a570aa7c679455d59899cc9b097bc66b3
MD5 f6758cd38bb77e1a3e7209c3b086424b
BLAKE2b-256 4c6f9b7eaab9d26e1c274e34d4d81161d14f4d4fe59ed79d0904d9da9886a32e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page