huggingface / huggingface/simulate

Documentation Feedback

Open
#321 2 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
195
Forks
13
Avg merge
58m
Merged PRs (30d)
1

Description

Hey there 👋 , the new documentation is 🤩 I have still some small stuff on what's already done. I don't open a PR because I'm not sure how you want to change the different points below:

1. We should add here: https://huggingface.co/docs/simulate/main/en/quicktour#loading-a-scene-from-the-hub-or-a-local-file

scene.show()

Since we show the cube just below. This way people can have the same result.

2.
![image](https://user-images.githubusercontent.com/13088472/195090915-8bb0444d-14f5-48f0-843e-bb8c08dd89a3.png)

3. Style is broken starting here: https://huggingface.co/docs/simulate/main/en/quicktour#objects-can-be-translated-rotated-scaled

4. Lack a Bibtext cite on readme.md 🤔

5. In Reinforcement Learning part there is a diagram missing
https://huggingface.co/docs/simulate/api/reward_functions#simulate.RewardFunction

Overall the look and content of this new version is beautiful and the explanation are super clear.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.