simulate icon indicating copy to clipboard operation
simulate copied to clipboard

Published 20 hours ago • verified publisher icon huggingface

Documentation Feedback

Open simoninithomas opened this issue 2 years ago • 2 comments

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.

image

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

  2. Lack a Bibtext cite on readme.md 🤔

  3. 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.

simoninithomas avatar Oct 11 '22 12:10 simoninithomas

As discussed in DMs, feel free to open PRs directly on this feedback. For BibTeX, you can use https://github.com/huggingface/diffusers#citation as a reference. If someone disagrees with any feedback/change, it will come up in the PR review :)

osanseviero avatar Oct 13 '22 07:10 osanseviero

Sorry for the delay I didn't had time yesterday, here's the PR: #332

simoninithomas avatar Oct 13 '22 08:10 simoninithomas