Farama-Foundation / Gymnasium

An API standard for single-agent reinforcement learning environments, with popular reference environments and related utilities (formerly Gym)
https://gymnasium.farama.org
MIT License
6.67k stars 750 forks source link

[Proposal] Add Tutorials for MuJoCo based environments (contributors welcome) #846

Open Kallinteris-Andreas opened 8 months ago

Kallinteris-Andreas commented 8 months ago

Proposal

With the release of the MuJoCo-v5 environments, in Gymnasium 1.0.0 (which will be coming out, prior to the heat death of the universe).

We need tutorials on:

Contributors are welcome, with experience running RL on robotic environments, or with knowledge of the MuJoCo simulator, or with knowledge of Robotics, or just willingness to learn. Comment here or discuss or join the gymnasium discord (invite link on the README) and ping me in the # New Contributors channel.

Motivation

No response

Pitch

No response

Alternatives

No response

Additional context

No response

Checklist

jonzamora commented 3 months ago

@Kallinteris-Andreas Is anyone working on Create a Custom MuJoCo based environment class by subclassing MujocoEnv? If not, I am working on just the right thing for this currently.

tldr; I am creating a MuJoCo version of X-MAGICAL, which is originally created with a 2D simulator and shown below:

shortstick-sweep

So far, my environment looks like this:

https://github.com/Farama-Foundation/Gymnasium/assets/50164418/b44ab71f-a0a7-4d41-bde3-9b6ed52d73ef

I'm integrating Gymnasium API support for the environment, and i'm doing this by subclassing MujocoEnv.

Let me know your thoughts, i'm happy to contribute this : )

Kallinteris-Andreas commented 1 month ago

@jonzamora feel free to submit a PR with your tutorial

(sorry for late reply, i though i had reply)