Skip to content

Commit e0e2ac3

Browse files
authored
docs: enhance README based on community feedback (#32)
- Add system requirements (Python 3.12, ≥24GB GPU VRAM) - Add HuggingFace CLI setup instructions - Add FAQ section addressing common questions - Clarify relationship with paper (what's included vs. not) - Add citation section Addresses feedback from GitHub issues #12, #19, #30.
1 parent ef88ec8 commit e0e2ac3

File tree

1 file changed

+99
-4
lines changed

1 file changed

+99
-4
lines changed

README.md

Lines changed: 99 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,21 @@
1212

1313
_Note: Following the release of [NVIDIA Alpamayo](https://nvidianews.nvidia.com/news/alpamayo-autonomous-vehicle-development) at CES 2026, Alpamayo-R1 has been renamed to Alpamayo 1._
1414

15+
> **📖 Please read the [HuggingFace Model Card](https://huggingface.co/nvidia/Alpamayo-R1-10B) first!**
16+
> The model card contains comprehensive details on model architecture, inputs/outputs, licensing, and tested hardware configurations. This GitHub README focuses on setup, usage, and frequently asked questions.
17+
18+
## Requirements
19+
20+
| Requirement | Specification |
21+
|-------------|---------------|
22+
| **Python** | 3.12.x (see `pyproject.toml`) |
23+
| **GPU** | NVIDIA GPU with ≥24 GB VRAM (e.g., RTX 3090, RTX 4090, A5000, H100) |
24+
| **OS** | Linux (tested); other platforms unverified |
25+
26+
> ⚠️ **Note**: GPUs with less than 24 GB VRAM will likely encounter CUDA out-of-memory errors.
27+
28+
## Installation
29+
1530
### 1. Install uv (if not already installed)
1631

1732
```bash
@@ -33,13 +48,19 @@ The model requires access to gated resources. Request access here:
3348
- 🤗 [Physical AI AV Dataset](https://huggingface.co/datasets/nvidia/PhysicalAI-Autonomous-Vehicles)
3449
- 🤗 [Alpamayo Model Weights](https://huggingface.co/nvidia/Alpamayo-R1-10B)
3550

36-
Then authenticate:
51+
Then authenticate using the HuggingFace CLI:
3752

3853
```bash
39-
hf auth login
54+
# Install huggingface-cli if not already installed (included in transformers)
55+
pip install huggingface_hub
56+
57+
# Login with your token
58+
huggingface-cli login
4059
```
4160

42-
Get your token at: https://huggingface.co/settings/tokens
61+
Get your access token at: https://huggingface.co/settings/tokens
62+
63+
> 💡 **Tip**: For more details on HuggingFace authentication, see the [official documentation](https://huggingface.co/docs/huggingface_hub/guides/cli).
4364
4465
## Running Inference
4566

@@ -60,6 +81,59 @@ the `num_traj_samples=1` argument to a higher number (Line 60).
6081

6182
We provide a notebook with similar inference code at `notebook/inference.ipynb`.
6283

84+
## Relationship with the Paper
85+
86+
Alpamayo 1 implements the architecture described in our paper [*"Alpamayo-R1: Bridging Reasoning and Action Prediction for Generalizable Autonomous Driving in the Long Tail
87+
"*](https://arxiv.org/abs/2511.00088), including:
88+
89+
| Feature | Paper Description | This Release (v1.0) |
90+
|---------|-------------------|---------------------|
91+
| **Chain-of-Causation (CoC) reasoning** | Hybrid auto-labeling with human in the loop for reasoning traces | ✅ Included |
92+
| **Vision-Language-Action architecture** | Cosmos-Reason backbone + action expert | ✅ Included |
93+
| **Trajectory prediction** | 6.4s horizon, 64 waypoints at 10 Hz | ✅ Included |
94+
| **RL post-training** | Reinforcement learning for reasoning/action consistency | ❌ Not in this release |
95+
| **Route/navigation conditioning** | Explicit navigation or route inputs | ❌ Not in this release |
96+
| **Meta-actions/General VQA** | High-level behavior and visual question answering | ❌ Not in this release |
97+
98+
The current release focuses on the core supervised learning components. RL post-training and route conditioning are potential candidates for future releases. Stay tuned!
99+
100+
## Frequently Asked Questions (FAQ)
101+
102+
<details>
103+
<summary><strong>Does the 10B model accept navigation/route inputs?</strong></summary>
104+
105+
While we have experimented with route conditioning capabilities, the released model does **not** include this feature. The current release takes multi-camera video and egomotion history as inputs, without explicit navigation or route inputs (e.g., waypoints, turn-by-turn navigation instructions).
106+
107+
</details>
108+
109+
<details>
110+
<summary><strong>Does the model produce meta-actions or support general VQA?</strong></summary>
111+
112+
While we have experimented with meta-action and general VQA capabilities, the released model does **not** include these features. Alpamayo 1 is designed specifically for trajectory prediction with Chain-of-Causation reasoning, producing trajectory + reasoning trace outputs.
113+
114+
</details>
115+
116+
<details>
117+
<summary><strong>Was the 10B model post-trained with Reinforcement Learning (RL)?</strong></summary>
118+
119+
No. The current 10B model release has **not** undergone RL post-training. While the paper describes RL stages for improving reasoning quality and action consistency, this release focuses on the supervised learning components. As mentioned above, we may release RL post-trained models in future releases.
120+
121+
</details>
122+
123+
<details>
124+
<summary><strong>What are the minimum GPU requirements?</strong></summary>
125+
126+
You need an NVIDIA GPU with at least **24 GB VRAM** for inference. Tested configurations include RTX 3090, A100, and H100. Running on GPUs with less memory (e.g., 16 GB) will likely result in CUDA out-of-memory errors.
127+
128+
</details>
129+
130+
<details>
131+
<summary><strong>Can I use this model in production / commercial applications?</strong></summary>
132+
133+
No. The model weights are released under a **non-commercial license**. This release is intended for research, experimentation, and evaluation purposes only. See the [License](#license) section and the [HuggingFace Model Card](https://huggingface.co/nvidia/Alpamayo-R1-10B) for details.
134+
135+
</details>
136+
63137
## Project Structure
64138

65139
```
@@ -96,9 +170,17 @@ The model uses Flash Attention 2 by default. If you encounter compatibility issu
96170
config.attn_implementation = "sdpa"
97171
```
98172

173+
### CUDA out-of-memory errors
174+
175+
If you encounter OOM errors:
176+
1. Ensure you have a GPU with at least 24 GB VRAM
177+
2. Reduce `num_traj_samples` if generating multiple trajectories
178+
3. Close other GPU-intensive applications
179+
99180
## License
100181

101-
Apache License 2.0 - see [LICENSE](./LICENSE) for details.
182+
- **Inference code**: Apache License 2.0 - see [LICENSE](./LICENSE) for details.
183+
- **Model weights**: Non-commercial license - see [HuggingFace Model Card](https://huggingface.co/nvidia/Alpamayo-R1-10B) for details.
102184

103185
## Disclaimer
104186

@@ -110,3 +192,16 @@ Important notes:
110192
- Alpamayo 1 is not a fully fledged driving stack. Among other limitations, it lacks access to critical real-world sensor inputs, does not incorporate required diverse and redundant safety mechanisms, and has not undergone automotive-grade validation for deployment.
111193

112194
By using this model, you acknowledge that it is a research tool intended to support scientific inquiry, benchmarking, and exploration—not a substitute for a certified AV stack. The developers and contributors disclaim any responsibility or liability for the use of the model or its outputs.
195+
196+
## Citation
197+
198+
If you use Alpamayo 1 in your research, please cite:
199+
200+
```bibtex
201+
@article{nvidia2025alpamayo,
202+
title={{Alpamayo-R1}: Bridging Reasoning and Action Prediction for Generalizable Autonomous Driving in the Long Tail},
203+
author={NVIDIA and Yan Wang and Wenjie Luo and Junjie Bai and Yulong Cao and Tong Che and Ke Chen and Yuxiao Chen and Jenna Diamond and Yifan Ding and Wenhao Ding and Liang Feng and Greg Heinrich and Jack Huang and Peter Karkus and Boyi Li and Pinyi Li and Tsung-Yi Lin and Dongran Liu and Ming-Yu Liu and Langechuan Liu and Zhijian Liu and Jason Lu and Yunxiang Mao and Pavlo Molchanov and Lindsey Pavao and Zhenghao Peng and Mike Ranzinger and Ed Schmerling and Shida Shen and Yunfei Shi and Sarah Tariq and Ran Tian and Tilman Wekel and Xinshuo Weng and Tianjun Xiao and Eric Yang and Xiaodong Yang and Yurong You and Xiaohui Zeng and Wenyuan Zhang and Boris Ivanovic and Marco Pavone},
204+
year={2025},
205+
journal={arXiv preprint arXiv:2511.00088},
206+
}
207+
```

0 commit comments

Comments
 (0)