Skip to content

OpenAI's Gym written in pure Rust for blazingly fast performance

License

Notifications You must be signed in to change notification settings

MathisWellmann/gym-rs

Repository files navigation

OpenAI Gym (Unofficial Rust Implementation)

This library aims be be close to the original OpenAI Gym library written in Python.

If you don't mind Python and would like to use the original implementation from Rust, check out a OpenAI Gym wrapper.

Prerequisites

This library use's SDL2 to enable various forms of rendering. Even when an SDL2 window is not explictly shown, renders can be saved to files making it a mandatory dependency if any form of rendering is to be done.

On Ubuntu you can install the dependency as such:

sudo apt install libsdl2-dev
sudo apt install libsdl2-gfx-dev

On Arch:

sudo pacman -S sdl2 sdl2_gfx

If your using nix, you can get into the reproducible build environment as simple as:

nix develop

Usage

To use this crate in your project, put this in your Cargo.toml:

[dependencies]
gym_rs = "0.3.0"

Usage on Windows:

As per #6, here are some instructions for the windows folks:

  1. clone the repo & cd to the root dir of the repo
  2. modify Cargo.toml, remove dependency sdl2 line and add following code:
[dependencies.sdl2]
version = "0.35.2"
default-features = false
features = ["static-link", "use-vcpkg", "gfx"]

[package.metadata.vcpkg]
dependencies = ["sdl2", "sdl2-gfx"]
git = "https://github.com/microsoft/vcpkg"
rev = "16ee2ec"

[package.metadata.vcpkg.target]
x86_64-pc-windows-msvc = { triplet = "x64-windows-static-md" }

  1. install cargo-vcpkg using cargo install cargo-vcpkg
  2. under the root dir of the repo, cargo vcpkg build
  3. now build and run, such as cargo run --example=mountain_car

Examples

cargo run --example=cartpole

cart_pole

cargo run --example=mountain_car

mountain_car

Contributions

Contributions are welcome. For the contribution guidelines, please take a look at CONTRIBUTING.md.

Donations

If you would like to support the development of this crate, feel free to send over a donation:

Monero:

47xMvxNKsCKMt2owkDuN1Bci2KMiqGrAFCQFSLijWLs49ua67222Wu3LZryyopDVPYgYmAnYkSZSz9ZW2buaDwdyKTWGwwb

monero