Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating MuJoCo docstrings #2616

Merged
merged 6 commits into from
Feb 17, 2022
Merged

Conversation

Markus28
Copy link
Contributor

@Markus28 Markus28 commented Feb 15, 2022

This is a WIP

Imo a big issue is that it's not clear how v2 and v3 relate and which version is actually being documented. Am I right in assuming that

  1. We concentrate on v3?
  2. The only difference between v3 and v2 is configurability? I.e. the default configuration of v3 is equivalent to v2? (That's what the current version info seems to imply)

Changes so far:

General Changes

  • Rephrase action space
  • In "Observation Space": "state space" -> "observations": This seems to be a recurring phrasing in the MuJoCo docs. My reason for changing this is two-fold: If we are being pedantic, the state space does not consist of positional values of different body parts, but of states. Secondly, there is a slight distinction between states and observations in the setting of POMDPs and we are mostly concerned about observations.
  • Change the tables for observation space to illustrate exclude_current_positions_from_observation=True and discuss exclude_current_positions_from_observation=False as special case
  • Talk about weights for reward terms
  • Update names of reward terms to match code
  • Note that individual reward terms are returned in info
  • Talk about terminate_when_unhealthy
  • Currently, the documentation is encouraging users to modify the XML assets that come with Gym. I don't think that's a good idea, especially since v3 allows to specify the path to a custom MuJoCo model.
  • Give a list of kwargs for make

Ant

  • Change y-coordinate to z-coordinate in termination criterion

Half Cheetah

  • Changed y-coordinate to z-coordinate. TODO: Is this correct?

Humanoid

  • Question: Is there any difference between "control" and "action". Why use the term "control"?
  • I cannot claim to understand cinert, cvel etc.

HumanoidStandup, InvertedDoublePendulum, InvertedPendulum

  • Remove v3 from version info

There are probably a bunch of changes that I forgot to mention in the list above

@jkterry1 jkterry1 marked this pull request as ready for review February 17, 2022 14:45
@jkterry1
Copy link
Collaborator

I'm merging this so it's in the docs string for the release, please create another PR for any addition changes agreed upon

@jkterry1 jkterry1 merged commit 95063a0 into openai:master Feb 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants