[Doc] Add a knowledge base #375
Conversation
vmoens
left a comment
There was a problem hiding this comment.
Great start
I made some comments.
I can also add errors that we had (pyopengl and such).
If you have any (might not be the case), referencing github threads when talking about an issue can also be useful (sometime the same error message has two or more different causes and the various solutions can be detailed in an issue somewhere out there).
COMMON_MUJOCO_ISSUES.md
Outdated
| 2. Rendered images are completely black. | ||
|
|
||
| > Make sure to call `env.render()` before reading the pixels. |
There was a problem hiding this comment.
Is this for gym?
mujoco can be used with dm_control too. I guess we'd like to specify what lib is being used?
There was a problem hiding this comment.
Good point! Will update the name of the library
COMMON_MUJOCO_ISSUES.md
Outdated
| 1. RuntimeError with error stack like this when running jobs using schedulers like slurm: | ||
|
|
||
| ``` | ||
| File "mjrendercontext.pyx", line 46, in mujoco_py.cymj.MjRenderContext.__init__ |
There was a problem hiding this comment.
This does not exist in the newest mujoco python bindings if i'm not wrong. Perhaps we could split this file in 'old' and 'new' mujoco bindings (they made a big revamp and it's probably worth splitting it according to the version).
There was a problem hiding this comment.
For now, the more practical solution maybe to just add the mujoco version here. I havent run into this issue on newer Mujoco (and dont even want to 😛 )
COMMON_MUJOCO_ISSUES.md
Outdated
| @@ -0,0 +1,27 @@ | |||
| ## Common Issues when rendering Mujoco Environments | |||
There was a problem hiding this comment.
What about a general "all you need to know about MUJOCO" file? Something that would tell users how to install mujoco_py on machines with GPUs, how to choose between new and old bindings, etc?
I can help to fill the gaps of course.
Do we want to have a separate folder with issues and installation tips (rather than putting them in the root directory)? Here it's mujoco but we might have issues with other things (distributed, hydra, other third party libraries). I guess on the long term these things will live in the doc.
There was a problem hiding this comment.
+1 to "all you need to know about MUJOCO". Also +1 to a separate folder. Maybe we can call it faq ?
There was a problem hiding this comment.
Oops saw it a bit late that you had renamed the folder to be knowledge_base already - sounds like a good name!
|
We could also refer this |
|
@shagunsodhani I took the liberty of modifying the file, moving it to a separate directory and sketching a couple of other files too. If you'd have time to give it a look it would be fantastic! |
# Conflicts: # README.md
Description
Add a knowledge base to torchrl.
Main contribution in terms of diffs:
Motivation and Context
Add a file with description of common issues with rendering mujoco envs.
Types of changes
What types of changes does your code introduce? Remove all that do not apply:
Checklist
Go over all the following points, and put an
xin all the boxes that apply.If you are unsure about any of these, don't hesitate to ask. We are here to help!