Repository navigation
Adds uv support as an alternative to conda in isaaclab.sh - #3172
Conversation
Mayankm96
left a comment
There was a problem hiding this comment.
Mainly NITs. Could you also update the setup instructions for UV? :)
It would be good to extend the support to Windows. If you don't have access to a Windows machine, could you please make a ticket so our team can look into it? Thank you!
Co-authored-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com> Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
Co-authored-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com> Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
|
I'm working on updating the docs accordingly. I don'y have access to a Windows machine so would greatly appreciate some help setting it up in the |
Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
|
Ok I believe the docs have been updated as needed. Only the |
|
@kellyguo11 shall we go ahead and merge this? We can make a separate MR on support for Windows. |
I want to say that no |
For |
If this is the case, then, please also update the following files to use |
Added note for users of 'uv' regarding pip replacement. Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
|
Done! I added a note that |
|
@KyleM73 could you help resolve the conflict and run through the formatter again? |
hhansen-bdai
left a comment
There was a problem hiding this comment.
🎉 Thanks, @KyleM73!
|
I merged IsaacLab main into the branch and made sure all formatter tests were passing! Thanks for the help getting this over the line :) edit: one sec need to push a bug fix, testing all the options in isaaclab.sh |
|
Timing comparison: TLDR: uv is 2x as fast as conda without caching, and with caching, uv is nearly 30x faster for reinstalls. uv (no torch cache): real 3m3.427s uv (torch cached) real 0m13.632s conda (no torch cache): real 6m9.684s conda (torch cached): real 6m12.353s Note: I have a few custom extensions that were installed as well, but the timing should be representative since both install methods performed the same installations. tests were run on an Ubuntu 22.04 system with Intel 10900K CPU and 3080 12Gb GPU. Clearing caches was not included in the reported times- the times are just for creating the virtual environment and installing IsaacLab with all rl frameworks. |
|
Adds issue #3438 to track for windows. Thanks again for the great work and benchmarking! We should at some point just default to UV for installation and make |
|
Sorry for missing this earlier but can you also add the license for UV inside |
|
done! |
Signed-off-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com>
…3172) # Description This PR adds support for uv as an alternative to conda or venv for managing virtual environments and adds corresponding support for uv pip for managing python dependencies. uv and uv pip is significantly faster than conda and has many useful tools. If users wish to use the uv workflow they will need to have uv installed, but otherwise no additional dependencies are added. Docs should be updated to describe this option. There may need to be more work done to clean when deactivating the environment. Uv does not support pre and post activation hooks like conda so cleaning up the environment variables is slightly more tricky. I would greatly appreciate feedback to improve this workflow! Fixes isaac-sim#3408 ## Type of change - New feature (non-breaking change which adds functionality) - This change requires a documentation update ## Checklist - [X] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [x] I have made corresponding changes to the documentation - [X] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have updated the changelog and the corresponding version in the extension's `config/extension.toml` file - [X] I have added my name to the `CONTRIBUTORS.md` or my name already exists there --------- Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com> Signed-off-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com> Co-authored-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com>
…3172) # Description This PR adds support for uv as an alternative to conda or venv for managing virtual environments and adds corresponding support for uv pip for managing python dependencies. uv and uv pip is significantly faster than conda and has many useful tools. If users wish to use the uv workflow they will need to have uv installed, but otherwise no additional dependencies are added. Docs should be updated to describe this option. There may need to be more work done to clean when deactivating the environment. Uv does not support pre and post activation hooks like conda so cleaning up the environment variables is slightly more tricky. I would greatly appreciate feedback to improve this workflow! Fixes isaac-sim#3408 ## Type of change - New feature (non-breaking change which adds functionality) - This change requires a documentation update ## Checklist - [X] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [x] I have made corresponding changes to the documentation - [X] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have updated the changelog and the corresponding version in the extension's `config/extension.toml` file - [X] I have added my name to the `CONTRIBUTORS.md` or my name already exists there --------- Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com> Signed-off-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com> Co-authored-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com>
…3172) This PR adds support for uv as an alternative to conda or venv for managing virtual environments and adds corresponding support for uv pip for managing python dependencies. uv and uv pip is significantly faster than conda and has many useful tools. If users wish to use the uv workflow they will need to have uv installed, but otherwise no additional dependencies are added. Docs should be updated to describe this option. There may need to be more work done to clean when deactivating the environment. Uv does not support pre and post activation hooks like conda so cleaning up the environment variables is slightly more tricky. I would greatly appreciate feedback to improve this workflow! Fixes isaac-sim#3408 - New feature (non-breaking change which adds functionality) - This change requires a documentation update - [X] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [x] I have made corresponding changes to the documentation - [X] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have updated the changelog and the corresponding version in the extension's `config/extension.toml` file - [X] I have added my name to the `CONTRIBUTORS.md` or my name already exists there --------- Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com> Signed-off-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com> Co-authored-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com>
…3172) # Description This PR adds support for uv as an alternative to conda or venv for managing virtual environments and adds corresponding support for uv pip for managing python dependencies. uv and uv pip is significantly faster than conda and has many useful tools. If users wish to use the uv workflow they will need to have uv installed, but otherwise no additional dependencies are added. Docs should be updated to describe this option. There may need to be more work done to clean when deactivating the environment. Uv does not support pre and post activation hooks like conda so cleaning up the environment variables is slightly more tricky. I would greatly appreciate feedback to improve this workflow! Fixes isaac-sim#3408 ## Type of change - New feature (non-breaking change which adds functionality) - This change requires a documentation update ## Checklist - [X] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [x] I have made corresponding changes to the documentation - [X] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have updated the changelog and the corresponding version in the extension's `config/extension.toml` file - [X] I have added my name to the `CONTRIBUTORS.md` or my name already exists there --------- Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com> Signed-off-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com> Co-authored-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com>
…3172) # Description This PR adds support for uv as an alternative to conda or venv for managing virtual environments and adds corresponding support for uv pip for managing python dependencies. uv and uv pip is significantly faster than conda and has many useful tools. If users wish to use the uv workflow they will need to have uv installed, but otherwise no additional dependencies are added. Docs should be updated to describe this option. There may need to be more work done to clean when deactivating the environment. Uv does not support pre and post activation hooks like conda so cleaning up the environment variables is slightly more tricky. I would greatly appreciate feedback to improve this workflow! Fixes isaac-sim#3408 ## Type of change - New feature (non-breaking change which adds functionality) - This change requires a documentation update ## Checklist - [X] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [x] I have made corresponding changes to the documentation - [X] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have updated the changelog and the corresponding version in the extension's `config/extension.toml` file - [X] I have added my name to the `CONTRIBUTORS.md` or my name already exists there --------- Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com> Signed-off-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com> Co-authored-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com>
Description
This PR adds support for uv as an alternative to conda or venv for managing virtual environments and adds corresponding support for uv pip for managing python dependencies. uv and uv pip is significantly faster than conda and has many useful tools.
If users wish to use the uv workflow they will need to have uv installed, but otherwise no additional dependencies are added.
Docs should be updated to describe this option. There may need to be more work done to clean when deactivating the environment. Uv does not support pre and post activation hooks like conda so cleaning up the environment variables is slightly more tricky. I would greatly appreciate feedback to improve this workflow!
Fixes #3408
Type of change
Checklist
pre-commitchecks with./isaaclab.sh --formatconfig/extension.tomlfileCONTRIBUTORS.mdor my name already exists there