akadmin/headroom
1
0
Fork 0
mirror of https://github.com/headroomlabs-ai/headroom.git synced 2026-08-27 14:17:10 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #37 from longtngo/fix/docker-install-hnswlib-core-dep

Browse source 
fix(docs): correct PyPI package name from headroom to headroom-ai
This commit is contained in:
Tejas Chopra 2026-03-02 12:39:07 -08:00 • committed by GitHub
commit ae661c8a2e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/quickstart.md
View file

@ -8,13 +8,13 @@ Get Headroom running in 5 minutes with these copy-paste examples.
```bash
# Core only (minimal dependencies)
pip install headroom
pip install headroom-ai
# With proxy server
pip install "headroom[proxy]"
pip install "headroom-ai[proxy]"
# Everything
pip install "headroom[all]"
pip install "headroom-ai[all]"
```
---

12
docs/troubleshooting.md
View file

@ -21,7 +21,7 @@ lsof -i :8787
headroom proxy --port 8788
# 3. Check for missing dependencies
pip install "headroom[proxy]"
pip install "headroom-ai[proxy]"
# 4. Run with debug logging
headroom proxy --log-level debug
@ -223,13 +223,13 @@ client = HeadroomClient(
```bash
# 1. Check it's installed in the right environment
pip show headroom
pip show headroom-ai
# 2. If using virtual environment, ensure it's activated
source venv/bin/activate # or equivalent
# 3. Reinstall
pip install --upgrade headroom
pip install --upgrade headroom-ai
```
### "ImportError: cannot import name 'X' from 'headroom'"
@ -256,13 +256,13 @@ from headroom import (
```bash
# For proxy server
pip install "headroom[proxy]"
pip install "headroom-ai[proxy]"
# For embedding-based relevance scoring
pip install "headroom[relevance]"
pip install "headroom-ai[relevance]"
# For everything
pip install "headroom[all]"
pip install "headroom-ai[all]"
```
---