Update README with clearer usage guide #72
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR restructures the README to provide clearer installation and usage instructions for FlashInfer+ROCm. The documentation is reorganized to prioritize quick-start options (pre-built Docker images and wheel packages) before development setup instructions.
Key changes include:
- Reorganized content with a new "Try It Out!" section featuring three installation options (pre-built Docker images, wheel packages, and building from source)
- Added ROCm 7.0.2 to the supported versions list
- Removed redundant Docker compatibility table and consolidated installation workflows
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| with flashinfer already installed into it. | ||
|
|
||
| Clone the latest trunk from <https://github.com/ROCm/flashinfer>. | ||
| b. **Activate the micromaba environment** |
There was a problem hiding this comment.
Spelling error: "micromaba" should be "micromamba".
| b. **Activate the micromaba environment** | |
| b. **Activate the micromamba environment** |
| e. Run some example | ||
|
|
||
| **Note:** The `--no-deps` flags assumes that all require dependencies are already available in the build environment. Otherwise, refer the earlier steps to install required packages. If building without first installing all Python and build dependencies, the `--no-deps` flag should be omitted. In that case, the build step will download all needed dependencies. | ||
| A basic example to test your environemnt is provided below. You can look for more examples |
There was a problem hiding this comment.
Spelling error: "environemnt" should be "environment".
| A basic example to test your environemnt is provided below. You can look for more examples | |
| A basic example to test your environment is provided below. You can look for more examples |
| mkdir build && cd build/ | ||
| cmake -DFLASHINFER_ENABLE_HIP=ON -DFLASHINFER_UNITTESTS=ON -GNinja .. | ||
| ninja build_tests | ||
| pip install flashinfer url https://pypi.amd.com/simple/flashinfer |
There was a problem hiding this comment.
The command syntax is incorrect. The command should be pip install flashinfer --extra-index-url https://pypi.amd.com/simple/ or similar, not pip install flashinfer url https://pypi.amd.com/simple/flashinfer.
| pip install flashinfer url https://pypi.amd.com/simple/flashinfer | |
| pip install flashinfer --extra-index-url https://pypi.amd.com/simple/ |
| 2025-11-21 01:03:30,921 - INFO - flashinfer.jit: Prebuilt kernels not found, using JIT backend | ||
| 0.2.5+rocm.1 | ||
| ``` | ||
| e. Run some example |
There was a problem hiding this comment.
Missing punctuation: The line should end with a period or colon for consistency with the documentation style.
| e. Run some example | |
| e. Run some example: |
| *TODO* | ||
|
|
There was a problem hiding this comment.
The section header "Step 1. Setup a development environment" has content marked as "TODO", indicating incomplete documentation. This should be completed before merging to provide users with complete installation instructions.
| *TODO* | |
| 1. **Install ROCm** | |
| Ensure you have a supported version of AMD ROCm installed on your system. | |
| Refer to the [ROCm installation guide](https://docs.amd.com/category/ROCm.html) for your operating system and hardware. | |
| 2. **Install Python (>=3.8) and pip** | |
| Make sure Python and pip are installed. You can check with: | |
| ```bash | |
| python3 --version | |
| pip3 --version |
If not installed, follow the instructions for your OS to install them.
-
(Recommended) Create and activate a Python virtual environment
python3 -m venv venv source venv/bin/activate -
Upgrade pip, setuptools, and wheel
pip install --upgrade pip setuptools wheel
-
Install build dependencies
pip install -r requirements.txt
If
requirements.txtis not present, install the following commonly required packages:pip install pytest cmake ninja
-
Install ROCm-compatible PyTorch
See instructions above or visit ROCm PyTorch wheels for the correct version.
Once these steps are complete, your development environment should be ready for building and testing FlashInfer+ROCm.
1 participant
Rewriting the README with proper usage and installation instructions