general cleanup overview #1715
general cleanup overview #1715
Conversation
mpgussert
requested review from
jsmith-bdai,
kellyguo11 and
Mayankm96
as code owners
| @@ -235,6 +235,63 @@ Clone the Isaac Lab repository into your workspace: | |||
| -d, --docs Build the documentation from source using sphinx. | |||
| -c, --conda [NAME] Create the conda environment for Isaac Lab. Default name is 'isaaclab'. | |||
|
|
|||
| Setting up the conda environment (optional) | |||
There was a problem hiding this comment.
conda steps are provided near the top of this page. don't we need to create the conda environment before installing isaac sim?
There was a problem hiding this comment.
I was copying the format of the binary install docs. I put it here to maintain parity between the two.
I think generally conda needs WAY more attention, and what to do where is a broader discussion.
I can move this, but I think we should move it in both if we do :)
|
|
||
| .. code:: bash | ||
|
|
||
| ./isaaclab.sh -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Repose-Cube-Shadow-Vision-Direct-v0 --enable_cameras |
There was a problem hiding this comment.
I wonder if we should start with a simpler environment to test. This particular one might take some time to load and it may not be the best initial experience for a quick test.
There was a problem hiding this comment.
it's not a test! it's a demo :)
The previous installation instructions verify things are working with create_empty. That's the test. The goal here is to show off what the platform can do in an easy one-liner. I also included the anymal environment. Maybe we should do just one (anymal)? also open to other suggestions :3 I just picked shadow hand because it's so damned COOL XD
| @@ -1,10 +1,7 @@ | |||
| Setting up Visual Studio Code | |||
| ----------------------------- | |||
|
|
|||
| The following is only applicable for Isaac Sim installed via the Omniverse Launcher. | |||
There was a problem hiding this comment.
I believe this is still valid, no?
There was a problem hiding this comment.
I don't think it is! I installed Isaac Sim with pip and I have been using Isaac Lab with VS code. I did this installation processes and it completed without errors. I haven't noticed anything weird (yet), but I also am not super well versed in VS code and its capabilities, so it's possible it's failing and I'm just not testing it.
TlDr; I think it works fine with the pip installed Isaac Sim on Windows, but someone more familiar with VS code may want to test it.
| @@ -276,8 +276,7 @@ behaves like a python executable, and can be used to run any python script or | |||
| module with the simulator. For more information, please refer to the | |||
| `documentation <https://docs.omniverse.nvidia.com/isaacsim/latest/manual_standalone_python.html#isaac-sim-python-environment>`__. | |||
|
|
|||
| Although using a virtual environment is optional, we recommend using ``conda``. To install | |||
| ``conda``, please follow the instructions `here <https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html>`__. | |||
| To install ``conda``, please follow the instructions `here <https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html>`__. | |||
There was a problem hiding this comment.
This sentence doesn't seem to flow as well with the next sentence. It's asking users to install conda first, then saying "in case you want to use conda..."
| @@ -1,10 +1,7 @@ | |||
| Setting up Visual Studio Code | |||
There was a problem hiding this comment.
If we are moving this under installation, I think we should make it clear this is only needed if you want to use VS Code for development. And we should test to see if this still works with pip installed isaac sim
There was a problem hiding this comment.
In my experience it has been working fine! see my comment below :)
| @@ -6,23 +6,15 @@ Task Design Workflows | |||
|
|
|||
| .. currentmodule:: omni.isaac.lab | |||
|
|
|||
| Environments define the interface between the agent and the simulation. In the simplest case, the environment provides | |||
There was a problem hiding this comment.
I actually quite like the previous descriptions in this page. I think they provide a bit more technical detail on what each of the workflow does, and the components of an environment. Could we try to combine them with some of the new things instead of removing many of the paragraphs?
| @@ -0,0 +1,17 @@ | |||
| Reinforcement Learning | |||
Going over grammar and phrasing in docs. moved vs code doc to installation section
Checklist
pre-commitchecks with./isaaclab.sh --formatconfig/extension.tomlfileCONTRIBUTORS.mdor my name already exists there