[Doc] Update README and fix a few installation related issues#347
Conversation
| ## Getting Started 🎯 | ||
|
|
||
| ### Step 1: Building rLLM | ||
| rLLM requires `Python >= 3.11`. You can install it either directly via pip or build from source. |
There was a problem hiding this comment.
3.10 is fine, only tinker requires 3.11.
There was a problem hiding this comment.
I think we can just enforce the user to use 3.11 now, given that Tinker has this requirement. This make sure user don't have to switch when they want to switch engine.
|
|
||
| ```bash | ||
| uv pip install "git+https://github.com/rllm-org/rllm.git" | ||
| uv pip install "rllm[verl] @ git+https://github.com/rllm-org/rllm.git" |
There was a problem hiding this comment.
not sure if there is any use case for a direct installation @jeffreysijuntan
and if we do we should change DatasetRegistry to cache the datasets and register file to some user location like ~./rllm
There was a problem hiding this comment.
Currently no, but I think it is a good idea to cache datasets to ~/.rllm anyway so we should support this feature.
| **Step 2: Install rLLM with Training Backend** | ||
|
|
||
| rLLM supports two training backends: `verl` and `Tinker`. Choose one based on your needs. | ||
| rLLM supports two training backends: `verl` and `tinker`. Choose one based on your needs. |
There was a problem hiding this comment.
they can always install both e.g., uv pip install -e .[verl,tinker]
There was a problem hiding this comment.
Yeah but I assume in most cases ppl would stick to only one of them maybe?
|
|
||
| # Install verl | ||
| bash scripts/install_verl.sh | ||
| # can add --torch-backend=auto to automatically detect the CUDA backend |
There was a problem hiding this comment.
in my testing, 'auto' did not work, ideally the user would always set this e.g., even in the cpu case they can set --torch-backend=cpu
There was a problem hiding this comment.
let's remove this comment then.
|
Thx for the review and great suggestions @kylemontgomery1. Since this PR relates to the crucial README, I would wait and see if @jeffreysijuntan has any comments (& response to some of the points you've raised). Will add a followup commit tmr. |
3 participants
What does this PR do?
v0.2.1release time, etc.install_verl.shto avoid confusion.verl/folder to.gitignore(in case users upgrade from an older version and might encounter this folder not being able to get removed).