Skip to main content

Package to receive goal-directed environments

Project description

GREnvs

Gym Environments adjusted to Goal Recognition tasks.

Installation

This repo is installable. The name of the package is gr_envs. The package serves as an extension with multiple gym environments and registration bundles that specifically fit GR frameworks, namely they are goal-conditioned.

The repo is distributed to Pypi. to install the repo: pip install gr_envs

Installing the repo registers the environments to gym, effectively enabling you to run your script\framework having the environments existing out-of-the-box.

If you're on windows and using vscode, you will need Microsoft Visual C++ 14.0 or greater. you can download a latest version here: https://visualstudio.microsoft.com/visual-cpp-build-tools/

Installing Extras

This package offers additional environments via optional extras. To install a specific environment extra, include it in the pip install command:

  • Minigrid Environment:
    Installs the minigrid dependency.

    pip install gr_envs[minigrid]
    
  • Panda Environment:
    Installs the panda_gym dependency.

    pip install gr_envs[panda]
    
  • Parking Environment:
    (Corresponds to the highway-env dependency.)

    pip install gr_envs[highway]
    
  • Point-Maze Environment:
    (Corresponds to the gymnasium-robotics dependency.)

    pip install gr_envs[maze]
    

Supported envs:

  • Minigrid
  • Panda
  • Parking
  • Point-Maze

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue if you have any suggestions or improvements.

License

This project is licensed under the MIT License.

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

gr_envs-1.0.tar.gz (20.2 kB view details)

Uploaded Source

Built Distribution

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

gr_envs-1.0-py3-none-any.whl (26.7 kB view details)

Uploaded Python 3

File details

Details for the file gr_envs-1.0.tar.gz.

File metadata

  • Download URL: gr_envs-1.0.tar.gz
  • Upload date:
  • Size: 20.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for gr_envs-1.0.tar.gz
Algorithm Hash digest
SHA256 64c1559036e8d2e214f88428a61bbcde2a616873610029f812f722d548201b28
MD5 a3cfd47354c0e7a667abd18d5a0502b0
BLAKE2b-256 6e43923b6720cb3f4eedca2f6baba59a369809317fcf4af83a3aad9de0b476ca

See more details on using hashes here.

File details

Details for the file gr_envs-1.0-py3-none-any.whl.

File metadata

  • Download URL: gr_envs-1.0-py3-none-any.whl
  • Upload date:
  • Size: 26.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for gr_envs-1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 267d8c37f42d1d3c80712e304b3be74d6277c9fb023bb0d6615be368205860b6
MD5 a86bd9d32393c1814799e72a972aa189
BLAKE2b-256 083b28acd5027e4da04811fc31febb1610488df4e1849780d9f0abd30bce2e76

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