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

Add tutorial Load custom quadruped robot environments using Gymnasium/MuJoCo/Ant-v5 framework #838

Merged

Conversation

Kallinteris-Andreas
Copy link
Collaborator

@Kallinteris-Andreas Kallinteris-Andreas commented Dec 12, 2023

Description

Adds a (hopefully) comprehensive tutorial on how to load quadruped robot models.

I would like a proofreading review, any comments/questions/requests are welcome (dumb questions are also welcome).

Should this be in the tutorials/gymnasium_basics section?

Also need to add it tutorial's toctree (which I can not figure out how to do it)

Type of change

  • Documentation change (no code changed)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

@Kallinteris-Andreas Kallinteris-Andreas marked this pull request as ready for review December 12, 2023 11:41
Copy link
Member

@pseudo-rnd-thoughts pseudo-rnd-thoughts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing, thanks for the tutorial

I have tried remaking the website (make html) but the tutorial doesn't appear in gymnasium_basic, I suspect that the tutorials need to all be python files

docs/tutorials/gymnasium_basics/load_quadruped_model.md Outdated Show resolved Hide resolved
docs/tutorials/gymnasium_basics/load_quadruped_model.md Outdated Show resolved Hide resolved
@Kallinteris-Andreas Kallinteris-Andreas marked this pull request as draft December 12, 2023 16:11
@Kallinteris-Andreas
Copy link
Collaborator Author

  1. renaming the file to .py or .rst does not fix the toctree, opening file:///home/vm/Gymnasium/docs/_build/dirhtml/tutorials/gymnasium_basics/load_quadruped_model/index.html works (change the path to gymnasium on your computer)
  2. I have decided to convert the PR to a draft to double-check the values. (the text is perfectly fine, feel free to review to it)

@Kallinteris-Andreas Kallinteris-Andreas marked this pull request as ready for review January 30, 2024 18:32
Copy link
Member

@pseudo-rnd-thoughts pseudo-rnd-thoughts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, my suggested changes

docs/tutorials/gymnasium_basics/load_quadruped_model.md Outdated Show resolved Hide resolved
docs/tutorials/gymnasium_basics/load_quadruped_model.md Outdated Show resolved Hide resolved
docs/tutorials/gymnasium_basics/load_quadruped_model.md Outdated Show resolved Hide resolved
docs/tutorials/gymnasium_basics/load_quadruped_model.md Outdated Show resolved Hide resolved
docs/tutorials/gymnasium_basics/load_quadruped_model.md Outdated Show resolved Hide resolved
docs/tutorials/gymnasium_basics/load_quadruped_model.md Outdated Show resolved Hide resolved
docs/tutorials/gymnasium_basics/load_quadruped_model.md Outdated Show resolved Hide resolved
@pseudo-rnd-thoughts pseudo-rnd-thoughts merged commit f88a618 into Farama-Foundation:main Feb 1, 2024
11 checks passed
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.

None yet

2 participants