Spaces:
Paused
Paused
Georg commited on
Commit ·
e15abf5
1
Parent(s): 24857f8
now with real weights
Browse files- Dockerfile +14 -2
- HF_MODEL_SETUP.md +163 -0
- PRIVATE_REPO_SETUP.md +211 -0
- README.md +33 -7
- README_SETUP.md +216 -0
- UPLOAD_WEIGHTS.md +328 -0
- app.py +1 -2
- download_weights.py +163 -40
- requirements.txt +3 -0
- verify_weights.py +138 -0
Dockerfile
CHANGED
|
@@ -7,6 +7,12 @@ ENV CUDA_HOME=/usr/local/cuda
|
|
| 7 |
ENV PATH=${CUDA_HOME}/bin:${PATH}
|
| 8 |
ENV LD_LIBRARY_PATH=${CUDA_HOME}/lib64:${LD_LIBRARY_PATH}
|
| 9 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 10 |
# Install system dependencies
|
| 11 |
RUN apt-get update && apt-get install -y \
|
| 12 |
git \
|
|
@@ -56,8 +62,14 @@ RUN bash build_all.sh || echo "Build completed with warnings"
|
|
| 56 |
WORKDIR /app
|
| 57 |
COPY . .
|
| 58 |
|
| 59 |
-
# Download model weights
|
| 60 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 61 |
|
| 62 |
# Expose port for Gradio
|
| 63 |
EXPOSE 7860
|
|
|
|
| 7 |
ENV PATH=${CUDA_HOME}/bin:${PATH}
|
| 8 |
ENV LD_LIBRARY_PATH=${CUDA_HOME}/lib64:${LD_LIBRARY_PATH}
|
| 9 |
|
| 10 |
+
# FoundationPose model configuration
|
| 11 |
+
# Override these in Space settings to enable real model
|
| 12 |
+
ENV FOUNDATIONPOSE_MODEL_REPO=gpue/foundationpose-weights
|
| 13 |
+
ENV USE_HF_WEIGHTS=true
|
| 14 |
+
ENV USE_REAL_MODEL=false
|
| 15 |
+
|
| 16 |
# Install system dependencies
|
| 17 |
RUN apt-get update && apt-get install -y \
|
| 18 |
git \
|
|
|
|
| 62 |
WORKDIR /app
|
| 63 |
COPY . .
|
| 64 |
|
| 65 |
+
# Download model weights from Hugging Face model repository
|
| 66 |
+
# The download_weights.py script will:
|
| 67 |
+
# 1. Check if weights already exist locally
|
| 68 |
+
# 2. Download from FOUNDATIONPOSE_MODEL_REPO if USE_HF_WEIGHTS=true
|
| 69 |
+
# 3. Fall back to placeholder mode if download fails
|
| 70 |
+
RUN echo "Downloading model weights from ${FOUNDATIONPOSE_MODEL_REPO}..." && \
|
| 71 |
+
python3 download_weights.py || \
|
| 72 |
+
echo "⚠️ Weights download failed or skipped. Space will run in placeholder mode."
|
| 73 |
|
| 74 |
# Expose port for Gradio
|
| 75 |
EXPOSE 7860
|
HF_MODEL_SETUP.md
ADDED
|
@@ -0,0 +1,163 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Quick Guide: Setting Up Model Weights on Hugging Face
|
| 2 |
+
|
| 3 |
+
**TL;DR:** Host your FoundationPose weights in a HF model repository instead of your Space. It's easier, faster, and better.
|
| 4 |
+
|
| 5 |
+
## Why This Way is Better
|
| 6 |
+
|
| 7 |
+
| Method | Pros | Cons |
|
| 8 |
+
|--------|------|------|
|
| 9 |
+
| **HF Model Repo** ✅ | Fast CDN downloads, version control, share across Spaces, no git-lfs needed | Initial setup required |
|
| 10 |
+
| Git-LFS in Space | All-in-one repo | Slow, complex, Space bloat, hard to share |
|
| 11 |
+
| Manual upload to Space files | Simple | Not version controlled, no programmatic access |
|
| 12 |
+
|
| 13 |
+
## 5-Minute Setup
|
| 14 |
+
|
| 15 |
+
### 1. Download Weights (One-Time)
|
| 16 |
+
|
| 17 |
+
```bash
|
| 18 |
+
# Download from Google Drive:
|
| 19 |
+
# https://drive.google.com/drive/folders/1GCyGE-LbFGgRC-FuGsF3a1zeBuzsQ1Da
|
| 20 |
+
|
| 21 |
+
# You need:
|
| 22 |
+
# - 2023-10-28-18-33-37/ (~900MB)
|
| 23 |
+
# - 2024-01-11-20-02-45/ (~900MB)
|
| 24 |
+
```
|
| 25 |
+
|
| 26 |
+
### 2. Create Model Repo
|
| 27 |
+
|
| 28 |
+
```bash
|
| 29 |
+
pip install huggingface_hub
|
| 30 |
+
huggingface-cli login
|
| 31 |
+
huggingface-cli repo create foundationpose-weights --type model
|
| 32 |
+
```
|
| 33 |
+
|
| 34 |
+
Or create at: https://huggingface.co/new (select "Model")
|
| 35 |
+
|
| 36 |
+
### 3. Upload Weights
|
| 37 |
+
|
| 38 |
+
```bash
|
| 39 |
+
cd /path/to/your/downloaded/weights
|
| 40 |
+
|
| 41 |
+
huggingface-cli upload YOUR_USERNAME/foundationpose-weights \
|
| 42 |
+
./2023-10-28-18-33-37 \
|
| 43 |
+
2023-10-28-18-33-37
|
| 44 |
+
|
| 45 |
+
huggingface-cli upload YOUR_USERNAME/foundationpose-weights \
|
| 46 |
+
./2024-01-11-20-02-45 \
|
| 47 |
+
2024-01-11-20-02-45
|
| 48 |
+
```
|
| 49 |
+
|
| 50 |
+
### 4. Configure Your Space
|
| 51 |
+
|
| 52 |
+
Add to your Space's environment variables (Settings → Variables and secrets):
|
| 53 |
+
|
| 54 |
+
```
|
| 55 |
+
FOUNDATIONPOSE_MODEL_REPO=YOUR_USERNAME/foundationpose-weights
|
| 56 |
+
USE_HF_WEIGHTS=true
|
| 57 |
+
USE_REAL_MODEL=true
|
| 58 |
+
```
|
| 59 |
+
|
| 60 |
+
### 5. Deploy
|
| 61 |
+
|
| 62 |
+
```bash
|
| 63 |
+
cd foundationpose
|
| 64 |
+
git push origin main
|
| 65 |
+
```
|
| 66 |
+
|
| 67 |
+
Your Space will automatically download weights on first run!
|
| 68 |
+
|
| 69 |
+
## Verify It Works
|
| 70 |
+
|
| 71 |
+
Check your Space logs at:
|
| 72 |
+
`https://huggingface.co/spaces/YOUR_USERNAME/foundationpose/logs`
|
| 73 |
+
|
| 74 |
+
Look for:
|
| 75 |
+
```
|
| 76 |
+
Downloading from Hugging Face Model Repository
|
| 77 |
+
Repository: YOUR_USERNAME/foundationpose-weights
|
| 78 |
+
✓ Download complete!
|
| 79 |
+
```
|
| 80 |
+
|
| 81 |
+
## Example Model Repo Structure
|
| 82 |
+
|
| 83 |
+
Your model repo should look like:
|
| 84 |
+
|
| 85 |
+
```
|
| 86 |
+
YOUR_USERNAME/foundationpose-weights/
|
| 87 |
+
├── README.md
|
| 88 |
+
├── 2023-10-28-18-33-37/
|
| 89 |
+
│ ├── model_0000000.pth
|
| 90 |
+
│ ├── config.json
|
| 91 |
+
│ └── ...
|
| 92 |
+
└── 2024-01-11-20-02-45/
|
| 93 |
+
├── model_0000000.pth
|
| 94 |
+
├── config.json
|
| 95 |
+
└── ...
|
| 96 |
+
```
|
| 97 |
+
|
| 98 |
+
## Use in Other Projects
|
| 99 |
+
|
| 100 |
+
Anyone can now use your weights:
|
| 101 |
+
|
| 102 |
+
```python
|
| 103 |
+
from huggingface_hub import snapshot_download
|
| 104 |
+
|
| 105 |
+
# Download weights
|
| 106 |
+
snapshot_download(
|
| 107 |
+
repo_id="YOUR_USERNAME/foundationpose-weights",
|
| 108 |
+
local_dir="./weights"
|
| 109 |
+
)
|
| 110 |
+
```
|
| 111 |
+
|
| 112 |
+
## Make It Public or Private?
|
| 113 |
+
|
| 114 |
+
**Public (Recommended):**
|
| 115 |
+
- ✅ Anyone can use (including your Space)
|
| 116 |
+
- ✅ No token needed
|
| 117 |
+
- ✅ Community can benefit
|
| 118 |
+
|
| 119 |
+
**Private:**
|
| 120 |
+
- ✅ Control access
|
| 121 |
+
- ❌ Need HF token in Space secrets
|
| 122 |
+
- ❌ More complex setup
|
| 123 |
+
|
| 124 |
+
For private repos, add `HF_TOKEN` to Space secrets.
|
| 125 |
+
|
| 126 |
+
## Common Issues
|
| 127 |
+
|
| 128 |
+
**"Repository not found"**
|
| 129 |
+
→ Check name matches: `YOUR_USERNAME/foundationpose-weights`
|
| 130 |
+
|
| 131 |
+
**"Access denied"**
|
| 132 |
+
→ Make repo public or add HF_TOKEN secret
|
| 133 |
+
|
| 134 |
+
**"Download slow"**
|
| 135 |
+
→ First download is cached, subsequent runs are instant
|
| 136 |
+
|
| 137 |
+
**"Out of space"**
|
| 138 |
+
→ Free tier: ~50GB. Upgrade or use smaller models.
|
| 139 |
+
|
| 140 |
+
## Complete Example
|
| 141 |
+
|
| 142 |
+
```bash
|
| 143 |
+
# Assuming weights downloaded to ~/Downloads/foundationpose-weights/
|
| 144 |
+
|
| 145 |
+
# 1. Login
|
| 146 |
+
huggingface-cli login
|
| 147 |
+
|
| 148 |
+
# 2. Create repo
|
| 149 |
+
huggingface-cli repo create foundationpose-weights --type model
|
| 150 |
+
|
| 151 |
+
# 3. Upload
|
| 152 |
+
cd ~/Downloads/foundationpose-weights
|
| 153 |
+
huggingface-cli upload gpue/foundationpose-weights . .
|
| 154 |
+
|
| 155 |
+
# 4. Done! Configure your Space:
|
| 156 |
+
# FOUNDATIONPOSE_MODEL_REPO=gpue/foundationpose-weights
|
| 157 |
+
# USE_HF_WEIGHTS=true
|
| 158 |
+
# USE_REAL_MODEL=true
|
| 159 |
+
```
|
| 160 |
+
|
| 161 |
+
---
|
| 162 |
+
|
| 163 |
+
**Full details:** See [UPLOAD_WEIGHTS.md](UPLOAD_WEIGHTS.md) for comprehensive guide.
|
PRIVATE_REPO_SETUP.md
ADDED
|
@@ -0,0 +1,211 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Private Model Repository Setup
|
| 2 |
+
|
| 3 |
+
Your model repository `gpue/foundationpose-weights` is currently **PRIVATE** 🔒
|
| 4 |
+
|
| 5 |
+
This document explains your options for using it with your Space.
|
| 6 |
+
|
| 7 |
+
---
|
| 8 |
+
|
| 9 |
+
## Quick Answer
|
| 10 |
+
|
| 11 |
+
**Yes, your Space needs a token** if the model repo stays private.
|
| 12 |
+
|
| 13 |
+
**No token needed** if you make the repo public.
|
| 14 |
+
|
| 15 |
+
---
|
| 16 |
+
|
| 17 |
+
## Option 1: Make Repository Public (Easiest) ✅
|
| 18 |
+
|
| 19 |
+
### Why Choose This?
|
| 20 |
+
- ✅ No token management
|
| 21 |
+
- ✅ Simpler Space setup
|
| 22 |
+
- ✅ Anyone can use your weights
|
| 23 |
+
- ✅ No secrets to manage
|
| 24 |
+
- ✅ Faster downloads (no auth overhead)
|
| 25 |
+
|
| 26 |
+
### How to Make Public
|
| 27 |
+
|
| 28 |
+
**Via CLI:**
|
| 29 |
+
```bash
|
| 30 |
+
/Users/georgpuschel/repos/robot-ml/training/.venv/bin/huggingface-cli repo update \
|
| 31 |
+
gpue/foundationpose-weights \
|
| 32 |
+
--visibility public \
|
| 33 |
+
--repo-type model
|
| 34 |
+
```
|
| 35 |
+
|
| 36 |
+
**Via Web:**
|
| 37 |
+
1. Go to https://huggingface.co/gpue/foundationpose-weights/settings
|
| 38 |
+
2. Under "Change repository visibility"
|
| 39 |
+
3. Select "Public"
|
| 40 |
+
4. Click "Update repository"
|
| 41 |
+
|
| 42 |
+
**Then:**
|
| 43 |
+
- Just deploy your Space - no additional setup needed!
|
| 44 |
+
- Weights will download automatically
|
| 45 |
+
|
| 46 |
+
---
|
| 47 |
+
|
| 48 |
+
## Option 2: Keep Private + Add Token 🔒
|
| 49 |
+
|
| 50 |
+
### Why Choose This?
|
| 51 |
+
- 🔒 Control access to weights
|
| 52 |
+
- 🔒 Keep it between your Spaces
|
| 53 |
+
- 🔒 Track who downloads
|
| 54 |
+
|
| 55 |
+
### Setup Steps
|
| 56 |
+
|
| 57 |
+
#### 1. Create HF Token
|
| 58 |
+
|
| 59 |
+
Go to https://huggingface.co/settings/tokens and create a new token:
|
| 60 |
+
|
| 61 |
+
- **Name:** `foundationpose-space` (or any name you want)
|
| 62 |
+
- **Type:** `Read` (not Write)
|
| 63 |
+
- **Permissions:**
|
| 64 |
+
- ✅ Read access to repos
|
| 65 |
+
|
| 66 |
+
Copy the token (starts with `hf_...`)
|
| 67 |
+
|
| 68 |
+
#### 2. Add Token to Space
|
| 69 |
+
|
| 70 |
+
Go to your Space settings:
|
| 71 |
+
https://huggingface.co/spaces/gpue/foundationpose/settings
|
| 72 |
+
|
| 73 |
+
Scroll to **"Repository secrets"** and add:
|
| 74 |
+
|
| 75 |
+
| Name | Value |
|
| 76 |
+
|------|-------|
|
| 77 |
+
| `HF_TOKEN` | `hf_xxxxxxxxxxxxx` (your token) |
|
| 78 |
+
|
| 79 |
+
#### 3. Verify
|
| 80 |
+
|
| 81 |
+
The code already supports token authentication:
|
| 82 |
+
- `download_weights.py` will automatically use `HF_TOKEN` if available
|
| 83 |
+
- No code changes needed!
|
| 84 |
+
|
| 85 |
+
#### 4. Test
|
| 86 |
+
|
| 87 |
+
Deploy your Space and check the logs:
|
| 88 |
+
```
|
| 89 |
+
🔒 Using HF_TOKEN for authentication (private repository)
|
| 90 |
+
Downloading model weights...
|
| 91 |
+
✓ Download complete!
|
| 92 |
+
```
|
| 93 |
+
|
| 94 |
+
---
|
| 95 |
+
|
| 96 |
+
## Current Status
|
| 97 |
+
|
| 98 |
+
✅ **Model repo uploaded:** 258MB (2 weight files + configs + README)
|
| 99 |
+
✅ **Token support added:** Code updated to use `HF_TOKEN` env var
|
| 100 |
+
✅ **Dockerfile configured:** Points to your model repo by default
|
| 101 |
+
❌ **Repository visibility:** Currently PRIVATE
|
| 102 |
+
|
| 103 |
+
---
|
| 104 |
+
|
| 105 |
+
## Recommendation
|
| 106 |
+
|
| 107 |
+
For a public inference Space like this, I recommend **making the model repo public**:
|
| 108 |
+
|
| 109 |
+
**Pros:**
|
| 110 |
+
- Simpler setup
|
| 111 |
+
- No token management
|
| 112 |
+
- Aligns with open-source spirit
|
| 113 |
+
- Easier for others to use
|
| 114 |
+
|
| 115 |
+
**Cons:**
|
| 116 |
+
- Anyone can download the weights (but they're from official FoundationPose anyway)
|
| 117 |
+
|
| 118 |
+
The FoundationPose weights are already public on Google Drive, so there's no confidentiality concern.
|
| 119 |
+
|
| 120 |
+
---
|
| 121 |
+
|
| 122 |
+
## Testing
|
| 123 |
+
|
| 124 |
+
### Verify Current Access
|
| 125 |
+
|
| 126 |
+
```bash
|
| 127 |
+
cd /Users/georgpuschel/repos/robot-ml/foundationpose
|
| 128 |
+
|
| 129 |
+
# Test without token (will fail if private)
|
| 130 |
+
unset HF_TOKEN
|
| 131 |
+
/Users/georgpuschel/repos/robot-ml/training/.venv/bin/python verify_weights.py
|
| 132 |
+
|
| 133 |
+
# Test with token (will work if token valid)
|
| 134 |
+
export HF_TOKEN="hf_your_token_here"
|
| 135 |
+
/Users/georgpuschel/repos/robot-ml/training/.venv/bin/python verify_weights.py
|
| 136 |
+
```
|
| 137 |
+
|
| 138 |
+
### After Making Public
|
| 139 |
+
|
| 140 |
+
```bash
|
| 141 |
+
# Should work without token
|
| 142 |
+
/Users/georgpuschel/repos/robot-ml/training/.venv/bin/python verify_weights.py
|
| 143 |
+
```
|
| 144 |
+
|
| 145 |
+
---
|
| 146 |
+
|
| 147 |
+
## What I've Done
|
| 148 |
+
|
| 149 |
+
1. ✅ Uploaded weights to `gpue/foundationpose-weights` (258MB)
|
| 150 |
+
2. ✅ Added README.md to model repo with citation and usage
|
| 151 |
+
3. ✅ Updated `download_weights.py` to support `HF_TOKEN`
|
| 152 |
+
4. ✅ Updated Dockerfile to point to your model repo
|
| 153 |
+
5. ✅ Created `verify_weights.py` to test access
|
| 154 |
+
6. ✅ Improved error messages for auth failures
|
| 155 |
+
|
| 156 |
+
---
|
| 157 |
+
|
| 158 |
+
## Next Steps (Choose One)
|
| 159 |
+
|
| 160 |
+
### If Making Public:
|
| 161 |
+
```bash
|
| 162 |
+
# 1. Make repo public
|
| 163 |
+
huggingface-cli repo update gpue/foundationpose-weights --visibility public --repo-type model
|
| 164 |
+
|
| 165 |
+
# 2. Deploy Space
|
| 166 |
+
cd /Users/georgpuschel/repos/robot-ml/foundationpose
|
| 167 |
+
git add .
|
| 168 |
+
git commit -m "Configure for model repo download"
|
| 169 |
+
git push origin main
|
| 170 |
+
|
| 171 |
+
# 3. Done! No token needed.
|
| 172 |
+
```
|
| 173 |
+
|
| 174 |
+
### If Keeping Private:
|
| 175 |
+
```bash
|
| 176 |
+
# 1. Get token from: https://huggingface.co/settings/tokens
|
| 177 |
+
|
| 178 |
+
# 2. Add HF_TOKEN to Space secrets:
|
| 179 |
+
# https://huggingface.co/spaces/gpue/foundationpose/settings
|
| 180 |
+
|
| 181 |
+
# 3. Deploy Space
|
| 182 |
+
cd /Users/georgpuschel/repos/robot-ml/foundationpose
|
| 183 |
+
git add .
|
| 184 |
+
git commit -m "Configure for model repo download"
|
| 185 |
+
git push origin main
|
| 186 |
+
|
| 187 |
+
# 4. Space will authenticate with token automatically
|
| 188 |
+
```
|
| 189 |
+
|
| 190 |
+
---
|
| 191 |
+
|
| 192 |
+
## FAQ
|
| 193 |
+
|
| 194 |
+
**Q: What if I forget to add the token?**
|
| 195 |
+
A: Space will run in placeholder mode (empty results but API works).
|
| 196 |
+
|
| 197 |
+
**Q: Can I change visibility later?**
|
| 198 |
+
A: Yes! You can switch between public/private anytime.
|
| 199 |
+
|
| 200 |
+
**Q: Does the token expire?**
|
| 201 |
+
A: Tokens can expire if you set an expiration date. Use "No expiration" for Spaces.
|
| 202 |
+
|
| 203 |
+
**Q: What if someone steals my token?**
|
| 204 |
+
A: They can only READ your model repos. Revoke and create a new token if compromised.
|
| 205 |
+
|
| 206 |
+
**Q: Can I use the same token for multiple Spaces?**
|
| 207 |
+
A: Yes! Same token works across all your Spaces.
|
| 208 |
+
|
| 209 |
+
---
|
| 210 |
+
|
| 211 |
+
**Recommendation:** Make the repo public for simplicity. The weights are already public via Google Drive anyway.
|
README.md
CHANGED
|
@@ -91,21 +91,47 @@ This Space is designed to work with the [robot-ml](https://github.com/gpuschel/r
|
|
| 91 |
```
|
| 92 |
3. Run training with perception: `make train`
|
| 93 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 94 |
## Performance
|
| 95 |
|
| 96 |
-
- **Cold Start**: 15-30 seconds (ZeroGPU allocation)
|
| 97 |
- **Warm Inference**: 0.5-2 seconds per query
|
| 98 |
- **Recommended Use**: Batch processing, validation, demos
|
| 99 |
|
| 100 |
For real-time training loops (30 Hz), use the local dummy estimator instead.
|
| 101 |
|
| 102 |
-
##
|
| 103 |
|
| 104 |
-
-
|
| 105 |
-
-
|
| 106 |
-
-
|
| 107 |
-
-
|
| 108 |
-
-
|
|
|
|
| 109 |
|
| 110 |
## Citation
|
| 111 |
|
|
|
|
| 91 |
```
|
| 92 |
3. Run training with perception: `make train`
|
| 93 |
|
| 94 |
+
## Setup
|
| 95 |
+
|
| 96 |
+
### Placeholder Mode (Default)
|
| 97 |
+
|
| 98 |
+
This Space runs in **placeholder mode** by default - the API works but returns empty pose results. Perfect for testing integrations!
|
| 99 |
+
|
| 100 |
+
### Enable Real Inference
|
| 101 |
+
|
| 102 |
+
To enable actual 6D pose estimation:
|
| 103 |
+
|
| 104 |
+
1. **Create a Hugging Face model repository** to host the weights (recommended)
|
| 105 |
+
- 📖 Quick guide: [HF_MODEL_SETUP.md](HF_MODEL_SETUP.md)
|
| 106 |
+
- 📖 Detailed guide: [UPLOAD_WEIGHTS.md](UPLOAD_WEIGHTS.md)
|
| 107 |
+
|
| 108 |
+
2. **Set environment variables** in this Space's settings:
|
| 109 |
+
```
|
| 110 |
+
FOUNDATIONPOSE_MODEL_REPO=YOUR_USERNAME/foundationpose-weights
|
| 111 |
+
USE_HF_WEIGHTS=true
|
| 112 |
+
USE_REAL_MODEL=true
|
| 113 |
+
```
|
| 114 |
+
|
| 115 |
+
3. **Restart the Space** - weights will download automatically!
|
| 116 |
+
|
| 117 |
+
**Why use a model repo?** Faster downloads, version control, share across Spaces, no git-lfs needed!
|
| 118 |
+
|
| 119 |
## Performance
|
| 120 |
|
| 121 |
+
- **Cold Start**: 15-30 seconds (ZeroGPU allocation + model loading)
|
| 122 |
- **Warm Inference**: 0.5-2 seconds per query
|
| 123 |
- **Recommended Use**: Batch processing, validation, demos
|
| 124 |
|
| 125 |
For real-time training loops (30 Hz), use the local dummy estimator instead.
|
| 126 |
|
| 127 |
+
## Documentation
|
| 128 |
|
| 129 |
+
- 🚀 [README_SETUP.md](README_SETUP.md) - Start here for setup
|
| 130 |
+
- ⚡ [QUICKSTART.md](QUICKSTART.md) - API usage & integration examples
|
| 131 |
+
- 📦 [HF_MODEL_SETUP.md](HF_MODEL_SETUP.md) - 5-minute model repo setup
|
| 132 |
+
- 📖 [UPLOAD_WEIGHTS.md](UPLOAD_WEIGHTS.md) - Detailed weight upload guide
|
| 133 |
+
- 🔧 [DEPLOYMENT.md](DEPLOYMENT.md) - Full deployment options
|
| 134 |
+
- 📊 [STATUS.md](STATUS.md) - Complete project status
|
| 135 |
|
| 136 |
## Citation
|
| 137 |
|
README_SETUP.md
ADDED
|
@@ -0,0 +1,216 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# FoundationPose Setup Guide
|
| 2 |
+
|
| 3 |
+
**Quick navigation to setup instructions:**
|
| 4 |
+
|
| 5 |
+
## 🎯 Choose Your Path
|
| 6 |
+
|
| 7 |
+
### Path 1: Test Without Weights (5 minutes)
|
| 8 |
+
|
| 9 |
+
Just want to test the API structure?
|
| 10 |
+
|
| 11 |
+
```bash
|
| 12 |
+
cd foundationpose
|
| 13 |
+
pip install -r requirements.txt
|
| 14 |
+
python app.py
|
| 15 |
+
```
|
| 16 |
+
|
| 17 |
+
✅ Works immediately
|
| 18 |
+
✅ No GPU needed
|
| 19 |
+
✅ Returns valid API responses (empty results)
|
| 20 |
+
✅ Perfect for developing client integrations
|
| 21 |
+
|
| 22 |
+
→ **No additional setup needed!**
|
| 23 |
+
|
| 24 |
+
---
|
| 25 |
+
|
| 26 |
+
### Path 2: Deploy with Real Weights (30 minutes)
|
| 27 |
+
|
| 28 |
+
Want actual 6D pose estimation?
|
| 29 |
+
|
| 30 |
+
**Step 1: Get Model Weights**
|
| 31 |
+
|
| 32 |
+
Option A: **Create HF Model Repo** (Recommended)
|
| 33 |
+
📖 **Guide:** [HF_MODEL_SETUP.md](HF_MODEL_SETUP.md) (Quick 5-min guide)
|
| 34 |
+
📖 **Detailed:** [UPLOAD_WEIGHTS.md](UPLOAD_WEIGHTS.md) (Full instructions)
|
| 35 |
+
|
| 36 |
+
```bash
|
| 37 |
+
# Quick version:
|
| 38 |
+
huggingface-cli login
|
| 39 |
+
huggingface-cli repo create foundationpose-weights --type model
|
| 40 |
+
huggingface-cli upload YOUR_USER/foundationpose-weights ./weights .
|
| 41 |
+
```
|
| 42 |
+
|
| 43 |
+
Option B: Manual Download (Not recommended)
|
| 44 |
+
- Download from Google Drive
|
| 45 |
+
- Use git-lfs to add to Space repo
|
| 46 |
+
- More complex, slower
|
| 47 |
+
|
| 48 |
+
**Step 2: Configure Space**
|
| 49 |
+
|
| 50 |
+
Add environment variables in Space settings:
|
| 51 |
+
```
|
| 52 |
+
FOUNDATIONPOSE_MODEL_REPO=YOUR_USER/foundationpose-weights
|
| 53 |
+
USE_HF_WEIGHTS=true
|
| 54 |
+
USE_REAL_MODEL=true
|
| 55 |
+
```
|
| 56 |
+
|
| 57 |
+
**Step 3: Deploy**
|
| 58 |
+
|
| 59 |
+
```bash
|
| 60 |
+
git push origin main
|
| 61 |
+
```
|
| 62 |
+
|
| 63 |
+
Done! Space will auto-download weights on first run.
|
| 64 |
+
|
| 65 |
+
---
|
| 66 |
+
|
| 67 |
+
## 📚 Documentation Index
|
| 68 |
+
|
| 69 |
+
| Document | Purpose | Read When |
|
| 70 |
+
|----------|---------|-----------|
|
| 71 |
+
| [HF_MODEL_SETUP.md](HF_MODEL_SETUP.md) | **Quick HF model repo setup** | Setting up weights (recommended way) |
|
| 72 |
+
| [UPLOAD_WEIGHTS.md](UPLOAD_WEIGHTS.md) | Detailed weight upload guide | Need step-by-step instructions |
|
| 73 |
+
| [QUICKSTART.md](QUICKSTART.md) | API usage & integration | Ready to use the API |
|
| 74 |
+
| [DEPLOYMENT.md](DEPLOYMENT.md) | Full deployment options | Want all the details |
|
| 75 |
+
| [STATUS.md](STATUS.md) | Complete project status | Want to know what's done/missing |
|
| 76 |
+
| [README.md](README.md) | Space homepage | First-time visitors |
|
| 77 |
+
|
| 78 |
+
---
|
| 79 |
+
|
| 80 |
+
## 🚀 Deployment Options Summary
|
| 81 |
+
|
| 82 |
+
### A. Placeholder Mode (Default)
|
| 83 |
+
|
| 84 |
+
```bash
|
| 85 |
+
# No setup needed
|
| 86 |
+
git push origin main
|
| 87 |
+
```
|
| 88 |
+
|
| 89 |
+
- Returns empty results
|
| 90 |
+
- Tests API structure
|
| 91 |
+
- No GPU costs
|
| 92 |
+
- Perfect for development
|
| 93 |
+
|
| 94 |
+
### B. Real Mode (Automatic Download)
|
| 95 |
+
|
| 96 |
+
```bash
|
| 97 |
+
# 1. Upload weights to HF model repo (see HF_MODEL_SETUP.md)
|
| 98 |
+
# 2. Set Space environment variables:
|
| 99 |
+
# FOUNDATIONPOSE_MODEL_REPO=YOUR_USER/foundationpose-weights
|
| 100 |
+
# USE_HF_WEIGHTS=true
|
| 101 |
+
# USE_REAL_MODEL=true
|
| 102 |
+
# 3. Deploy
|
| 103 |
+
git push origin main
|
| 104 |
+
```
|
| 105 |
+
|
| 106 |
+
- Automatic weight download
|
| 107 |
+
- Real pose estimation
|
| 108 |
+
- ZeroGPU inference
|
| 109 |
+
- Production-ready
|
| 110 |
+
|
| 111 |
+
### C. Real Mode (Manual Weights)
|
| 112 |
+
|
| 113 |
+
```bash
|
| 114 |
+
# 1. Download weights manually
|
| 115 |
+
# 2. Add with git-lfs
|
| 116 |
+
git lfs track "weights/**"
|
| 117 |
+
git add weights/
|
| 118 |
+
git commit -m "Add weights"
|
| 119 |
+
# 3. Set USE_REAL_MODEL=true
|
| 120 |
+
git push origin main
|
| 121 |
+
```
|
| 122 |
+
|
| 123 |
+
- Weights included in Space
|
| 124 |
+
- Slower deployments
|
| 125 |
+
- Larger Space size
|
| 126 |
+
- Not recommended
|
| 127 |
+
|
| 128 |
+
---
|
| 129 |
+
|
| 130 |
+
## 🔗 Integration with robot-ml
|
| 131 |
+
|
| 132 |
+
Once your Space is running:
|
| 133 |
+
|
| 134 |
+
**1. Update wrapper:**
|
| 135 |
+
```python
|
| 136 |
+
from foundationpose.client import FoundationPoseClient
|
| 137 |
+
|
| 138 |
+
client = FoundationPoseClient("https://YOUR_USER-foundationpose.hf.space")
|
| 139 |
+
```
|
| 140 |
+
|
| 141 |
+
**2. Update config:**
|
| 142 |
+
```yaml
|
| 143 |
+
perception:
|
| 144 |
+
enabled: true
|
| 145 |
+
model: foundation_pose
|
| 146 |
+
api_url: https://YOUR_USER-foundationpose.hf.space
|
| 147 |
+
```
|
| 148 |
+
|
| 149 |
+
**Full integration code:** See [QUICKSTART.md](QUICKSTART.md#integration-with-robot-ml)
|
| 150 |
+
|
| 151 |
+
---
|
| 152 |
+
|
| 153 |
+
## ❓ FAQ
|
| 154 |
+
|
| 155 |
+
**Q: Do I need a GPU?**
|
| 156 |
+
A: No. ZeroGPU allocates GPU on-demand when needed.
|
| 157 |
+
|
| 158 |
+
**Q: How much does it cost?**
|
| 159 |
+
A: ZeroGPU is free with usage limits. Placeholder mode uses no GPU.
|
| 160 |
+
|
| 161 |
+
**Q: Can I use someone else's weights?**
|
| 162 |
+
A: Yes! If someone has a public model repo: `FOUNDATIONPOSE_MODEL_REPO=their-username/foundationpose-weights`
|
| 163 |
+
|
| 164 |
+
**Q: How big are the weights?**
|
| 165 |
+
A: ~1.8GB total (900MB refiner + 900MB scorer)
|
| 166 |
+
|
| 167 |
+
**Q: Where do I get the weights?**
|
| 168 |
+
A: Download from [Google Drive](https://drive.google.com/drive/folders/1GCyGE-LbFGgRC-FuGsF3a1zeBuzsQ1Da) then upload to HF model repo.
|
| 169 |
+
|
| 170 |
+
**Q: Can I test locally?**
|
| 171 |
+
A: Yes! `python test_local.py` tests everything locally first.
|
| 172 |
+
|
| 173 |
+
**Q: What if weight download fails?**
|
| 174 |
+
A: Space will run in placeholder mode automatically. Check logs for errors.
|
| 175 |
+
|
| 176 |
+
---
|
| 177 |
+
|
| 178 |
+
## 🎯 Recommended Workflow
|
| 179 |
+
|
| 180 |
+
```
|
| 181 |
+
1. Test locally first
|
| 182 |
+
→ python test_local.py
|
| 183 |
+
|
| 184 |
+
2. Deploy placeholder mode
|
| 185 |
+
→ Test Space works
|
| 186 |
+
|
| 187 |
+
3. Create HF model repo
|
| 188 |
+
→ Upload weights
|
| 189 |
+
→ See HF_MODEL_SETUP.md
|
| 190 |
+
|
| 191 |
+
4. Enable real mode
|
| 192 |
+
→ Set environment variables
|
| 193 |
+
→ Space auto-downloads weights
|
| 194 |
+
|
| 195 |
+
5. Integrate with robot-ml
|
| 196 |
+
→ See QUICKSTART.md
|
| 197 |
+
```
|
| 198 |
+
|
| 199 |
+
---
|
| 200 |
+
|
| 201 |
+
## 🆘 Getting Help
|
| 202 |
+
|
| 203 |
+
- **General questions:** See [QUICKSTART.md](QUICKSTART.md)
|
| 204 |
+
- **Deployment issues:** See [DEPLOYMENT.md](DEPLOYMENT.md)
|
| 205 |
+
- **Weight upload:** See [UPLOAD_WEIGHTS.md](UPLOAD_WEIGHTS.md) or [HF_MODEL_SETUP.md](HF_MODEL_SETUP.md)
|
| 206 |
+
- **Project status:** See [STATUS.md](STATUS.md)
|
| 207 |
+
- **API usage:** See [QUICKSTART.md](QUICKSTART.md)
|
| 208 |
+
|
| 209 |
+
---
|
| 210 |
+
|
| 211 |
+
**Start here:**
|
| 212 |
+
→ Test locally: `python test_local.py`
|
| 213 |
+
→ Want real weights: [HF_MODEL_SETUP.md](HF_MODEL_SETUP.md)
|
| 214 |
+
→ Deploy: `git push origin main`
|
| 215 |
+
|
| 216 |
+
That's it! 🎉
|
UPLOAD_WEIGHTS.md
ADDED
|
@@ -0,0 +1,328 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# How to Upload FoundationPose Weights to Hugging Face
|
| 2 |
+
|
| 3 |
+
This guide shows you how to host FoundationPose model weights in a Hugging Face model repository, which is much better than using git-lfs in your Space.
|
| 4 |
+
|
| 5 |
+
## Why Use a Model Repository?
|
| 6 |
+
|
| 7 |
+
✅ **Benefits:**
|
| 8 |
+
- Designed for large files (GB+)
|
| 9 |
+
- Fast CDN downloads
|
| 10 |
+
- Version control for weights
|
| 11 |
+
- Share weights across multiple Spaces
|
| 12 |
+
- No need for git-lfs in Space repo
|
| 13 |
+
- Better download performance
|
| 14 |
+
|
| 15 |
+
## Step-by-Step Guide
|
| 16 |
+
|
| 17 |
+
### 1. Download Official Weights
|
| 18 |
+
|
| 19 |
+
First, get the official FoundationPose weights from Google Drive:
|
| 20 |
+
|
| 21 |
+
**Download Link:** https://drive.google.com/drive/folders/1GCyGE-LbFGgRC-FuGsF3a1zeBuzsQ1Da
|
| 22 |
+
|
| 23 |
+
Download these two folders:
|
| 24 |
+
- `2023-10-28-18-33-37/` (refiner weights, ~900MB)
|
| 25 |
+
- `2024-01-11-20-02-45/` (scorer weights, ~900MB)
|
| 26 |
+
|
| 27 |
+
Save them locally in a directory structure like:
|
| 28 |
+
```
|
| 29 |
+
foundationpose-weights/
|
| 30 |
+
├── 2023-10-28-18-33-37/
|
| 31 |
+
│ ├── model.pth
|
| 32 |
+
│ └── ...
|
| 33 |
+
└── 2024-01-11-20-02-45/
|
| 34 |
+
├── model.pth
|
| 35 |
+
└── ...
|
| 36 |
+
```
|
| 37 |
+
|
| 38 |
+
### 2. Create Hugging Face Model Repository
|
| 39 |
+
|
| 40 |
+
**Option A: Using the Web Interface**
|
| 41 |
+
|
| 42 |
+
1. Go to https://huggingface.co/new
|
| 43 |
+
2. Choose "Model" (not Space or Dataset)
|
| 44 |
+
3. Set owner to your username (e.g., `gpue`)
|
| 45 |
+
4. Set name: `foundationpose-weights`
|
| 46 |
+
5. Make it **Public** (so your Space can download it) or Private (requires token)
|
| 47 |
+
6. Click "Create model"
|
| 48 |
+
|
| 49 |
+
**Option B: Using the CLI**
|
| 50 |
+
|
| 51 |
+
```bash
|
| 52 |
+
pip install huggingface_hub
|
| 53 |
+
huggingface-cli login # Enter your token
|
| 54 |
+
|
| 55 |
+
# Create repo
|
| 56 |
+
huggingface-cli repo create foundationpose-weights --type model
|
| 57 |
+
```
|
| 58 |
+
|
| 59 |
+
### 3. Upload Weights to Model Repository
|
| 60 |
+
|
| 61 |
+
**Option A: Using the Web Interface**
|
| 62 |
+
|
| 63 |
+
1. Go to your model repo: `https://huggingface.co/YOUR_USERNAME/foundationpose-weights`
|
| 64 |
+
2. Click "Files" → "Add file" → "Upload files"
|
| 65 |
+
3. Drag and drop the two weight folders
|
| 66 |
+
4. Click "Commit changes"
|
| 67 |
+
|
| 68 |
+
⚠️ **Note:** Web upload may be slow for large files. Use CLI for better experience.
|
| 69 |
+
|
| 70 |
+
**Option B: Using the CLI (Recommended)**
|
| 71 |
+
|
| 72 |
+
```bash
|
| 73 |
+
# From the directory containing your weight folders
|
| 74 |
+
huggingface-cli upload YOUR_USERNAME/foundationpose-weights ./2023-10-28-18-33-37 2023-10-28-18-33-37
|
| 75 |
+
huggingface-cli upload YOUR_USERNAME/foundationpose-weights ./2024-01-11-20-02-45 2024-01-11-20-02-45
|
| 76 |
+
```
|
| 77 |
+
|
| 78 |
+
**Option C: Using Python Script**
|
| 79 |
+
|
| 80 |
+
```python
|
| 81 |
+
from huggingface_hub import HfApi
|
| 82 |
+
from pathlib import Path
|
| 83 |
+
|
| 84 |
+
api = HfApi()
|
| 85 |
+
repo_id = "YOUR_USERNAME/foundationpose-weights"
|
| 86 |
+
weights_dir = Path("./foundationpose-weights")
|
| 87 |
+
|
| 88 |
+
print("Uploading weights to Hugging Face...")
|
| 89 |
+
|
| 90 |
+
# Upload entire directory
|
| 91 |
+
api.upload_folder(
|
| 92 |
+
folder_path=str(weights_dir),
|
| 93 |
+
repo_id=repo_id,
|
| 94 |
+
repo_type="model"
|
| 95 |
+
)
|
| 96 |
+
|
| 97 |
+
print("✓ Upload complete!")
|
| 98 |
+
```
|
| 99 |
+
|
| 100 |
+
### 4. Add Model Card (README)
|
| 101 |
+
|
| 102 |
+
Create a `README.md` in your model repo to document the weights:
|
| 103 |
+
|
| 104 |
+
```markdown
|
| 105 |
+
---
|
| 106 |
+
license: cc-by-nc-4.0
|
| 107 |
+
tags:
|
| 108 |
+
- computer-vision
|
| 109 |
+
- 6d-pose-estimation
|
| 110 |
+
- object-detection
|
| 111 |
+
- robotics
|
| 112 |
+
---
|
| 113 |
+
|
| 114 |
+
# FoundationPose Model Weights
|
| 115 |
+
|
| 116 |
+
Pre-trained weights for [FoundationPose](https://github.com/NVlabs/FoundationPose) 6D object pose estimation model.
|
| 117 |
+
|
| 118 |
+
## Model Details
|
| 119 |
+
|
| 120 |
+
- **Refiner weights:** `2023-10-28-18-33-37/`
|
| 121 |
+
- **Scorer weights:** `2024-01-11-20-02-45/`
|
| 122 |
+
- **Source:** [Official FoundationPose release](https://github.com/NVlabs/FoundationPose)
|
| 123 |
+
|
| 124 |
+
## Usage
|
| 125 |
+
|
| 126 |
+
```python
|
| 127 |
+
from huggingface_hub import snapshot_download
|
| 128 |
+
|
| 129 |
+
# Download all weights
|
| 130 |
+
snapshot_download(
|
| 131 |
+
repo_id="YOUR_USERNAME/foundationpose-weights",
|
| 132 |
+
local_dir="./weights"
|
| 133 |
+
)
|
| 134 |
+
```
|
| 135 |
+
|
| 136 |
+
## Citation
|
| 137 |
+
|
| 138 |
+
```bibtex
|
| 139 |
+
@inproceedings{wen2023foundationpose,
|
| 140 |
+
title={FoundationPose: Unified 6D Pose Estimation and Tracking of Novel Objects},
|
| 141 |
+
author={Wen, Bowen and Yang, Wei and Kautz, Jan and Birchfield, Stan},
|
| 142 |
+
booktitle={CVPR},
|
| 143 |
+
year={2024}
|
| 144 |
+
}
|
| 145 |
+
```
|
| 146 |
+
|
| 147 |
+
## License
|
| 148 |
+
|
| 149 |
+
These weights are from the official FoundationPose release and subject to NVIDIA's license terms.
|
| 150 |
+
```
|
| 151 |
+
|
| 152 |
+
### 5. Configure Your Space to Use the Model Repo
|
| 153 |
+
|
| 154 |
+
Update your Space's environment variables (Settings → Variables and secrets):
|
| 155 |
+
|
| 156 |
+
```
|
| 157 |
+
FOUNDATIONPOSE_MODEL_REPO=YOUR_USERNAME/foundationpose-weights
|
| 158 |
+
USE_HF_WEIGHTS=true
|
| 159 |
+
USE_REAL_MODEL=true
|
| 160 |
+
```
|
| 161 |
+
|
| 162 |
+
Or set in your Space's Dockerfile/code:
|
| 163 |
+
|
| 164 |
+
```python
|
| 165 |
+
import os
|
| 166 |
+
os.environ["FOUNDATIONPOSE_MODEL_REPO"] = "gpue/foundationpose-weights"
|
| 167 |
+
os.environ["USE_HF_WEIGHTS"] = "true"
|
| 168 |
+
```
|
| 169 |
+
|
| 170 |
+
### 6. Test the Setup
|
| 171 |
+
|
| 172 |
+
**Test locally:**
|
| 173 |
+
|
| 174 |
+
```bash
|
| 175 |
+
cd foundationpose
|
| 176 |
+
|
| 177 |
+
# Set environment variables
|
| 178 |
+
export FOUNDATIONPOSE_MODEL_REPO="YOUR_USERNAME/foundationpose-weights"
|
| 179 |
+
export USE_HF_WEIGHTS="true"
|
| 180 |
+
|
| 181 |
+
# Download weights
|
| 182 |
+
python download_weights.py
|
| 183 |
+
|
| 184 |
+
# Should see:
|
| 185 |
+
# ✓ Download complete!
|
| 186 |
+
# ✓ Model weights found locally!
|
| 187 |
+
```
|
| 188 |
+
|
| 189 |
+
**Test in Space:**
|
| 190 |
+
|
| 191 |
+
After pushing to HF Spaces, check the build logs:
|
| 192 |
+
1. Go to your Space → Logs
|
| 193 |
+
2. Look for "Downloading from Hugging Face Model Repository"
|
| 194 |
+
3. Should see "✓ Download complete!"
|
| 195 |
+
|
| 196 |
+
### 7. Verify Weights Are Correct
|
| 197 |
+
|
| 198 |
+
Check that the downloaded structure matches:
|
| 199 |
+
|
| 200 |
+
```bash
|
| 201 |
+
ls -R weights/
|
| 202 |
+
|
| 203 |
+
# Should show:
|
| 204 |
+
# weights/2023-10-28-18-33-37/
|
| 205 |
+
# weights/2024-01-11-20-02-45/
|
| 206 |
+
```
|
| 207 |
+
|
| 208 |
+
## Troubleshooting
|
| 209 |
+
|
| 210 |
+
### "Repository not found"
|
| 211 |
+
|
| 212 |
+
- Check repo name matches exactly: `YOUR_USERNAME/foundationpose-weights`
|
| 213 |
+
- Make sure repo is Public, or provide HF token for private repos
|
| 214 |
+
- Verify you're logged in: `huggingface-cli whoami`
|
| 215 |
+
|
| 216 |
+
### "Upload failed"
|
| 217 |
+
|
| 218 |
+
- Check your internet connection
|
| 219 |
+
- Try uploading smaller chunks
|
| 220 |
+
- Use CLI instead of web interface for large files
|
| 221 |
+
|
| 222 |
+
### "Out of storage"
|
| 223 |
+
|
| 224 |
+
- HF free tier has storage limits (~50GB)
|
| 225 |
+
- Request more storage or use smaller model variants
|
| 226 |
+
- Host on your own S3/CDN as alternative
|
| 227 |
+
|
| 228 |
+
### Private Repository Access
|
| 229 |
+
|
| 230 |
+
If your model repo is private, set HF token in Space secrets:
|
| 231 |
+
|
| 232 |
+
1. Get token from https://huggingface.co/settings/tokens
|
| 233 |
+
2. Add to Space: Settings → Repository secrets → `HF_TOKEN`
|
| 234 |
+
3. Code will automatically use it:
|
| 235 |
+
|
| 236 |
+
```python
|
| 237 |
+
from huggingface_hub import snapshot_download
|
| 238 |
+
import os
|
| 239 |
+
|
| 240 |
+
snapshot_download(
|
| 241 |
+
repo_id="YOUR_USERNAME/foundationpose-weights",
|
| 242 |
+
local_dir="./weights",
|
| 243 |
+
token=os.environ.get("HF_TOKEN") # Uses secret
|
| 244 |
+
)
|
| 245 |
+
```
|
| 246 |
+
|
| 247 |
+
## Example: Complete Workflow
|
| 248 |
+
|
| 249 |
+
```bash
|
| 250 |
+
# 1. Download from Google Drive (manual)
|
| 251 |
+
# Save to: ~/Downloads/foundationpose-weights/
|
| 252 |
+
|
| 253 |
+
# 2. Install HF CLI
|
| 254 |
+
pip install huggingface_hub
|
| 255 |
+
huggingface-cli login
|
| 256 |
+
|
| 257 |
+
# 3. Create model repo
|
| 258 |
+
huggingface-cli repo create foundationpose-weights --type model
|
| 259 |
+
|
| 260 |
+
# 4. Upload weights
|
| 261 |
+
cd ~/Downloads/foundationpose-weights
|
| 262 |
+
huggingface-cli upload gpue/foundationpose-weights . .
|
| 263 |
+
|
| 264 |
+
# 5. Update your Space
|
| 265 |
+
cd /path/to/foundationpose
|
| 266 |
+
git add .
|
| 267 |
+
git commit -m "Use HF model repo for weights"
|
| 268 |
+
git push
|
| 269 |
+
|
| 270 |
+
# 6. Set Space secrets
|
| 271 |
+
# Go to: https://huggingface.co/spaces/gpue/foundationpose/settings
|
| 272 |
+
# Add: FOUNDATIONPOSE_MODEL_REPO=gpue/foundationpose-weights
|
| 273 |
+
# Add: USE_HF_WEIGHTS=true
|
| 274 |
+
# Add: USE_REAL_MODEL=true
|
| 275 |
+
|
| 276 |
+
# 7. Check Space logs
|
| 277 |
+
# Visit: https://huggingface.co/spaces/gpue/foundationpose/logs
|
| 278 |
+
# Should see weights downloading automatically
|
| 279 |
+
```
|
| 280 |
+
|
| 281 |
+
## Alternative: Public Model Repos
|
| 282 |
+
|
| 283 |
+
If someone else has already uploaded the weights, you can use their repo:
|
| 284 |
+
|
| 285 |
+
```bash
|
| 286 |
+
# Example (if available)
|
| 287 |
+
export FOUNDATIONPOSE_MODEL_REPO="some-user/foundationpose-weights"
|
| 288 |
+
```
|
| 289 |
+
|
| 290 |
+
Common public repos (check if they exist):
|
| 291 |
+
- `nvidia/foundationpose` (official, if available)
|
| 292 |
+
- Community uploads (search on HF)
|
| 293 |
+
|
| 294 |
+
## Cost
|
| 295 |
+
|
| 296 |
+
✅ **Free tier:**
|
| 297 |
+
- Unlimited model repos
|
| 298 |
+
- ~50GB storage per repo
|
| 299 |
+
- Unlimited downloads (public repos)
|
| 300 |
+
- No bandwidth costs
|
| 301 |
+
|
| 302 |
+
📈 **Pro tier ($9/month):**
|
| 303 |
+
- More storage
|
| 304 |
+
- Private repos with teams
|
| 305 |
+
- Priority support
|
| 306 |
+
|
| 307 |
+
---
|
| 308 |
+
|
| 309 |
+
**Quick Reference:**
|
| 310 |
+
|
| 311 |
+
```bash
|
| 312 |
+
# Create repo
|
| 313 |
+
huggingface-cli repo create foundationpose-weights --type model
|
| 314 |
+
|
| 315 |
+
# Upload
|
| 316 |
+
huggingface-cli upload YOUR_USERNAME/foundationpose-weights ./weights .
|
| 317 |
+
|
| 318 |
+
# Download in Space (automatic)
|
| 319 |
+
python download_weights.py
|
| 320 |
+
|
| 321 |
+
# Or download manually
|
| 322 |
+
from huggingface_hub import snapshot_download
|
| 323 |
+
snapshot_download("YOUR_USERNAME/foundationpose-weights", local_dir="./weights")
|
| 324 |
+
```
|
| 325 |
+
|
| 326 |
+
---
|
| 327 |
+
|
| 328 |
+
You're all set! Your FoundationPose Space will now automatically download weights from your model repository on first run. 🎉
|
app.py
CHANGED
|
@@ -564,6 +564,5 @@ if __name__ == "__main__":
|
|
| 564 |
demo.launch(
|
| 565 |
server_name="0.0.0.0",
|
| 566 |
server_port=7860,
|
| 567 |
-
share=False
|
| 568 |
-
show_api=True
|
| 569 |
)
|
|
|
|
| 564 |
demo.launch(
|
| 565 |
server_name="0.0.0.0",
|
| 566 |
server_port=7860,
|
| 567 |
+
share=False
|
|
|
|
| 568 |
)
|
download_weights.py
CHANGED
|
@@ -1,9 +1,9 @@
|
|
| 1 |
#!/usr/bin/env python3
|
| 2 |
"""
|
| 3 |
-
Download FoundationPose pre-trained model weights.
|
| 4 |
|
| 5 |
-
|
| 6 |
-
|
| 7 |
"""
|
| 8 |
|
| 9 |
import os
|
|
@@ -11,63 +11,186 @@ import sys
|
|
| 11 |
from pathlib import Path
|
| 12 |
|
| 13 |
try:
|
| 14 |
-
import
|
| 15 |
except ImportError:
|
| 16 |
-
print("Installing
|
| 17 |
-
os.system(f"{sys.executable} -m pip install
|
| 18 |
-
import
|
| 19 |
|
| 20 |
|
| 21 |
-
|
| 22 |
-
|
| 23 |
-
|
| 24 |
-
|
| 25 |
|
| 26 |
-
|
| 27 |
-
|
| 28 |
-
weights_files = {
|
| 29 |
-
# Model checkpoint folders
|
| 30 |
-
"2023-10-28-18-33-37": "FOLDER_ID_1", # TODO: Replace with actual folder ID
|
| 31 |
-
"2024-01-11-20-02-45": "FOLDER_ID_2", # TODO: Replace with actual folder ID
|
| 32 |
-
}
|
| 33 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 34 |
print("=" * 60)
|
| 35 |
-
print("
|
| 36 |
print("=" * 60)
|
|
|
|
|
|
|
| 37 |
print()
|
| 38 |
-
|
| 39 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 40 |
print()
|
| 41 |
-
print("
|
| 42 |
-
print("
|
| 43 |
-
print("
|
|
|
|
|
|
|
|
|
|
|
|
|
| 44 |
print()
|
| 45 |
-
print(
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 46 |
print()
|
| 47 |
-
print("=" * 60)
|
| 48 |
|
| 49 |
-
|
| 50 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 51 |
weights_dir / "2023-10-28-18-33-37",
|
| 52 |
weights_dir / "2024-01-11-20-02-45"
|
| 53 |
]
|
| 54 |
|
| 55 |
-
|
| 56 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 57 |
return True
|
| 58 |
-
|
| 59 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 60 |
print()
|
| 61 |
-
|
| 62 |
-
|
| 63 |
-
|
| 64 |
-
|
| 65 |
-
print(" git add weights/")
|
| 66 |
-
print(" git commit -m 'Add model weights'")
|
| 67 |
print()
|
| 68 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 69 |
|
| 70 |
|
| 71 |
if __name__ == "__main__":
|
|
|
|
| 72 |
success = download_weights()
|
| 73 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
#!/usr/bin/env python3
|
| 2 |
"""
|
| 3 |
+
Download FoundationPose pre-trained model weights from Hugging Face.
|
| 4 |
|
| 5 |
+
Weights can be hosted in a HF model repository (recommended) or downloaded
|
| 6 |
+
manually from the official Google Drive.
|
| 7 |
"""
|
| 8 |
|
| 9 |
import os
|
|
|
|
| 11 |
from pathlib import Path
|
| 12 |
|
| 13 |
try:
|
| 14 |
+
from huggingface_hub import hf_hub_download, snapshot_download
|
| 15 |
except ImportError:
|
| 16 |
+
print("Installing huggingface_hub...")
|
| 17 |
+
os.system(f"{sys.executable} -m pip install huggingface_hub")
|
| 18 |
+
from huggingface_hub import hf_hub_download, snapshot_download
|
| 19 |
|
| 20 |
|
| 21 |
+
# Configuration
|
| 22 |
+
HF_MODEL_REPO = os.environ.get("FOUNDATIONPOSE_MODEL_REPO", "gpue/foundationpose-weights")
|
| 23 |
+
USE_HF_WEIGHTS = os.environ.get("USE_HF_WEIGHTS", "true").lower() == "true"
|
| 24 |
+
|
| 25 |
|
| 26 |
+
def download_from_huggingface(weights_dir: Path) -> bool:
|
| 27 |
+
"""Download weights from Hugging Face model repository.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 28 |
|
| 29 |
+
Args:
|
| 30 |
+
weights_dir: Directory to save weights
|
| 31 |
+
|
| 32 |
+
Returns:
|
| 33 |
+
True if successful
|
| 34 |
+
"""
|
| 35 |
print("=" * 60)
|
| 36 |
+
print("Downloading from Hugging Face Model Repository")
|
| 37 |
print("=" * 60)
|
| 38 |
+
print(f"Repository: {HF_MODEL_REPO}")
|
| 39 |
+
print(f"Target: {weights_dir.absolute()}")
|
| 40 |
print()
|
| 41 |
+
|
| 42 |
+
try:
|
| 43 |
+
# Get HF token if available (for private repos)
|
| 44 |
+
hf_token = os.environ.get("HF_TOKEN")
|
| 45 |
+
if hf_token:
|
| 46 |
+
print("🔒 Using HF_TOKEN for authentication (private repository)")
|
| 47 |
+
|
| 48 |
+
print("Downloading model weights...")
|
| 49 |
+
print("(This may take several minutes on first run)")
|
| 50 |
+
print()
|
| 51 |
+
|
| 52 |
+
# Download entire repository
|
| 53 |
+
snapshot_download(
|
| 54 |
+
repo_id=HF_MODEL_REPO,
|
| 55 |
+
local_dir=str(weights_dir),
|
| 56 |
+
local_dir_use_symlinks=False,
|
| 57 |
+
resume_download=True,
|
| 58 |
+
token=hf_token # Will use token if provided, None otherwise
|
| 59 |
+
)
|
| 60 |
+
|
| 61 |
+
print()
|
| 62 |
+
print("✓ Download complete!")
|
| 63 |
+
return True
|
| 64 |
+
|
| 65 |
+
except Exception as e:
|
| 66 |
+
error_msg = str(e).lower()
|
| 67 |
+
print(f"✗ Download failed: {e}")
|
| 68 |
+
print()
|
| 69 |
+
|
| 70 |
+
# Check if it's an authentication error
|
| 71 |
+
if "401" in error_msg or "403" in error_msg or "authentication" in error_msg or "token" in error_msg:
|
| 72 |
+
print("🔒 Authentication Error - Repository is private!")
|
| 73 |
+
print()
|
| 74 |
+
print("Solutions:")
|
| 75 |
+
print(" Option 1: Make repository public")
|
| 76 |
+
print(f" Visit: https://huggingface.co/{HF_MODEL_REPO}/settings")
|
| 77 |
+
print(" Change visibility to 'Public'")
|
| 78 |
+
print()
|
| 79 |
+
print(" Option 2: Add HF token to Space secrets")
|
| 80 |
+
print(" 1. Get token: https://huggingface.co/settings/tokens")
|
| 81 |
+
print(" 2. Add to Space secrets as 'HF_TOKEN'")
|
| 82 |
+
print()
|
| 83 |
+
else:
|
| 84 |
+
print("Possible issues:")
|
| 85 |
+
print(f" 1. Repository '{HF_MODEL_REPO}' doesn't exist")
|
| 86 |
+
print(" 2. Repository is private (need HF_TOKEN in secrets)")
|
| 87 |
+
print(" 3. Network error")
|
| 88 |
+
print()
|
| 89 |
+
print("To create the model repository:")
|
| 90 |
+
print(" 1. Visit: https://huggingface.co/new")
|
| 91 |
+
print(" 2. Create a model repo (e.g., 'gpue/foundationpose-weights')")
|
| 92 |
+
print(" 3. Upload weights using:")
|
| 93 |
+
print(" huggingface-cli upload gpue/foundationpose-weights ./weights/")
|
| 94 |
+
print()
|
| 95 |
+
return False
|
| 96 |
+
|
| 97 |
+
|
| 98 |
+
def manual_download_instructions(weights_dir: Path):
|
| 99 |
+
"""Print instructions for manual weight download."""
|
| 100 |
+
print("=" * 60)
|
| 101 |
+
print("Manual Weight Download Instructions")
|
| 102 |
+
print("=" * 60)
|
| 103 |
print()
|
| 104 |
+
print("Option 1: Download from official Google Drive")
|
| 105 |
+
print("-" * 40)
|
| 106 |
+
print("1. Visit: https://drive.google.com/drive/folders/1GCyGE-LbFGgRC-FuGsF3a1zeBuzsQ1Da")
|
| 107 |
+
print("2. Download these folders:")
|
| 108 |
+
print(" - 2023-10-28-18-33-37/ (refiner weights)")
|
| 109 |
+
print(" - 2024-01-11-20-02-45/ (scorer weights)")
|
| 110 |
+
print(f"3. Extract to: {weights_dir.absolute()}")
|
| 111 |
print()
|
| 112 |
+
print("Option 2: Create Hugging Face model repository")
|
| 113 |
+
print("-" * 40)
|
| 114 |
+
print("1. Download weights from Google Drive (see above)")
|
| 115 |
+
print("2. Create HF model repo: https://huggingface.co/new")
|
| 116 |
+
print("3. Upload weights:")
|
| 117 |
+
print(" pip install huggingface_hub")
|
| 118 |
+
print(" huggingface-cli login")
|
| 119 |
+
print(f" huggingface-cli upload YOUR_USERNAME/foundationpose-weights {weights_dir}/")
|
| 120 |
+
print("4. Set environment variable:")
|
| 121 |
+
print(f" export FOUNDATIONPOSE_MODEL_REPO=YOUR_USERNAME/foundationpose-weights")
|
| 122 |
print()
|
|
|
|
| 123 |
|
| 124 |
+
|
| 125 |
+
def check_weights_exist(weights_dir: Path) -> bool:
|
| 126 |
+
"""Check if weights already exist locally.
|
| 127 |
+
|
| 128 |
+
Args:
|
| 129 |
+
weights_dir: Directory containing weights
|
| 130 |
+
|
| 131 |
+
Returns:
|
| 132 |
+
True if weights exist
|
| 133 |
+
"""
|
| 134 |
+
required_folders = [
|
| 135 |
weights_dir / "2023-10-28-18-33-37",
|
| 136 |
weights_dir / "2024-01-11-20-02-45"
|
| 137 |
]
|
| 138 |
|
| 139 |
+
return all(folder.exists() and any(folder.iterdir()) for folder in required_folders)
|
| 140 |
+
|
| 141 |
+
|
| 142 |
+
def download_weights() -> bool:
|
| 143 |
+
"""Download or check for FoundationPose weights.
|
| 144 |
+
|
| 145 |
+
Returns:
|
| 146 |
+
True if weights are available
|
| 147 |
+
"""
|
| 148 |
+
weights_dir = Path("weights")
|
| 149 |
+
weights_dir.mkdir(exist_ok=True)
|
| 150 |
+
|
| 151 |
+
# Check if weights already exist
|
| 152 |
+
if check_weights_exist(weights_dir):
|
| 153 |
+
print("✓ Model weights found locally!")
|
| 154 |
+
print(f" Location: {weights_dir.absolute()}")
|
| 155 |
return True
|
| 156 |
+
|
| 157 |
+
print("Model weights not found locally.")
|
| 158 |
+
print()
|
| 159 |
+
|
| 160 |
+
# Try downloading from Hugging Face
|
| 161 |
+
if USE_HF_WEIGHTS:
|
| 162 |
+
print(f"Attempting to download from Hugging Face...")
|
| 163 |
+
print(f"Repository: {HF_MODEL_REPO}")
|
| 164 |
print()
|
| 165 |
+
|
| 166 |
+
if download_from_huggingface(weights_dir):
|
| 167 |
+
return True
|
| 168 |
+
|
|
|
|
|
|
|
| 169 |
print()
|
| 170 |
+
print("Hugging Face download failed. See manual instructions below.")
|
| 171 |
+
print()
|
| 172 |
+
|
| 173 |
+
# Show manual instructions
|
| 174 |
+
manual_download_instructions(weights_dir)
|
| 175 |
+
|
| 176 |
+
return False
|
| 177 |
|
| 178 |
|
| 179 |
if __name__ == "__main__":
|
| 180 |
+
print()
|
| 181 |
success = download_weights()
|
| 182 |
+
print()
|
| 183 |
+
|
| 184 |
+
if success:
|
| 185 |
+
print("=" * 60)
|
| 186 |
+
print("✓ Ready to use FoundationPose!")
|
| 187 |
+
print("=" * 60)
|
| 188 |
+
sys.exit(0)
|
| 189 |
+
else:
|
| 190 |
+
print("=" * 60)
|
| 191 |
+
print("⚠ Weights not available")
|
| 192 |
+
print("=" * 60)
|
| 193 |
+
print()
|
| 194 |
+
print("Space will run in PLACEHOLDER mode.")
|
| 195 |
+
print("To enable real inference, follow instructions above.")
|
| 196 |
+
sys.exit(1)
|
requirements.txt
CHANGED
|
@@ -5,6 +5,9 @@ numpy>=1.24.0
|
|
| 5 |
opencv-python>=4.8.0
|
| 6 |
Pillow>=10.0.0
|
| 7 |
|
|
|
|
|
|
|
|
|
|
| 8 |
# Deep learning
|
| 9 |
torch>=2.0.0
|
| 10 |
torchvision>=0.15.0
|
|
|
|
| 5 |
opencv-python>=4.8.0
|
| 6 |
Pillow>=10.0.0
|
| 7 |
|
| 8 |
+
# Hugging Face
|
| 9 |
+
huggingface_hub>=0.20.0
|
| 10 |
+
|
| 11 |
# Deep learning
|
| 12 |
torch>=2.0.0
|
| 13 |
torchvision>=0.15.0
|
verify_weights.py
ADDED
|
@@ -0,0 +1,138 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#!/usr/bin/env python3
|
| 2 |
+
"""
|
| 3 |
+
Verify that FoundationPose weights are accessible from Hugging Face model repository.
|
| 4 |
+
|
| 5 |
+
This script checks:
|
| 6 |
+
1. Model repo exists and is accessible
|
| 7 |
+
2. Required weight files are present
|
| 8 |
+
3. Files can be downloaded successfully
|
| 9 |
+
"""
|
| 10 |
+
|
| 11 |
+
import os
|
| 12 |
+
import sys
|
| 13 |
+
from pathlib import Path
|
| 14 |
+
|
| 15 |
+
try:
|
| 16 |
+
from huggingface_hub import list_repo_files, hf_hub_download
|
| 17 |
+
except ImportError:
|
| 18 |
+
print("❌ huggingface_hub not installed")
|
| 19 |
+
print("Install with: pip install huggingface_hub")
|
| 20 |
+
sys.exit(1)
|
| 21 |
+
|
| 22 |
+
# Configuration
|
| 23 |
+
MODEL_REPO = os.environ.get("FOUNDATIONPOSE_MODEL_REPO", "gpue/foundationpose-weights")
|
| 24 |
+
|
| 25 |
+
# Required files
|
| 26 |
+
REQUIRED_FILES = [
|
| 27 |
+
"2023-10-28-18-33-37/config.yml",
|
| 28 |
+
"2023-10-28-18-33-37/model_best.pth",
|
| 29 |
+
"2024-01-11-20-02-45/config.yml",
|
| 30 |
+
"2024-01-11-20-02-45/model_best.pth",
|
| 31 |
+
]
|
| 32 |
+
|
| 33 |
+
|
| 34 |
+
def verify_repo_access():
|
| 35 |
+
"""Verify model repository is accessible."""
|
| 36 |
+
print(f"Checking repository: {MODEL_REPO}")
|
| 37 |
+
print("-" * 60)
|
| 38 |
+
|
| 39 |
+
try:
|
| 40 |
+
files = list_repo_files(repo_id=MODEL_REPO, repo_type="model")
|
| 41 |
+
print(f"✓ Repository accessible")
|
| 42 |
+
print(f"✓ Found {len(files)} files")
|
| 43 |
+
return files
|
| 44 |
+
except Exception as e:
|
| 45 |
+
print(f"❌ Cannot access repository: {e}")
|
| 46 |
+
return None
|
| 47 |
+
|
| 48 |
+
|
| 49 |
+
def verify_required_files(repo_files):
|
| 50 |
+
"""Verify all required weight files are present."""
|
| 51 |
+
print("\nChecking required files:")
|
| 52 |
+
print("-" * 60)
|
| 53 |
+
|
| 54 |
+
all_present = True
|
| 55 |
+
for required_file in REQUIRED_FILES:
|
| 56 |
+
if required_file in repo_files:
|
| 57 |
+
print(f"✓ {required_file}")
|
| 58 |
+
else:
|
| 59 |
+
print(f"❌ Missing: {required_file}")
|
| 60 |
+
all_present = False
|
| 61 |
+
|
| 62 |
+
return all_present
|
| 63 |
+
|
| 64 |
+
|
| 65 |
+
def test_download():
|
| 66 |
+
"""Test downloading a small file."""
|
| 67 |
+
print("\nTesting download:")
|
| 68 |
+
print("-" * 60)
|
| 69 |
+
|
| 70 |
+
try:
|
| 71 |
+
# Download a small config file to test connectivity
|
| 72 |
+
test_file = "2023-10-28-18-33-37/config.yml"
|
| 73 |
+
print(f"Downloading {test_file}...")
|
| 74 |
+
|
| 75 |
+
downloaded = hf_hub_download(
|
| 76 |
+
repo_id=MODEL_REPO,
|
| 77 |
+
filename=test_file,
|
| 78 |
+
repo_type="model"
|
| 79 |
+
)
|
| 80 |
+
|
| 81 |
+
print(f"✓ Download successful: {downloaded}")
|
| 82 |
+
|
| 83 |
+
# Check file size
|
| 84 |
+
size = Path(downloaded).stat().st_size
|
| 85 |
+
print(f"✓ File size: {size:,} bytes")
|
| 86 |
+
|
| 87 |
+
return True
|
| 88 |
+
|
| 89 |
+
except Exception as e:
|
| 90 |
+
print(f"❌ Download failed: {e}")
|
| 91 |
+
return False
|
| 92 |
+
|
| 93 |
+
|
| 94 |
+
def main():
|
| 95 |
+
"""Run all verification checks."""
|
| 96 |
+
print("=" * 60)
|
| 97 |
+
print("FoundationPose Model Repository Verification")
|
| 98 |
+
print("=" * 60)
|
| 99 |
+
print()
|
| 100 |
+
|
| 101 |
+
# Check 1: Repository access
|
| 102 |
+
repo_files = verify_repo_access()
|
| 103 |
+
if repo_files is None:
|
| 104 |
+
print("\n❌ Verification failed: Cannot access repository")
|
| 105 |
+
sys.exit(1)
|
| 106 |
+
|
| 107 |
+
# Check 2: Required files
|
| 108 |
+
has_all_files = verify_required_files(repo_files)
|
| 109 |
+
if not has_all_files:
|
| 110 |
+
print("\n❌ Verification failed: Missing required files")
|
| 111 |
+
sys.exit(1)
|
| 112 |
+
|
| 113 |
+
# Check 3: Download test
|
| 114 |
+
can_download = test_download()
|
| 115 |
+
if not can_download:
|
| 116 |
+
print("\n❌ Verification failed: Cannot download files")
|
| 117 |
+
sys.exit(1)
|
| 118 |
+
|
| 119 |
+
# All checks passed
|
| 120 |
+
print()
|
| 121 |
+
print("=" * 60)
|
| 122 |
+
print("✓ All verification checks passed!")
|
| 123 |
+
print("=" * 60)
|
| 124 |
+
print()
|
| 125 |
+
print(f"Model repository '{MODEL_REPO}' is ready to use.")
|
| 126 |
+
print()
|
| 127 |
+
print("To use in your Space:")
|
| 128 |
+
print(" 1. Set environment variable:")
|
| 129 |
+
print(f" FOUNDATIONPOSE_MODEL_REPO={MODEL_REPO}")
|
| 130 |
+
print(" 2. Set USE_HF_WEIGHTS=true")
|
| 131 |
+
print(" 3. Set USE_REAL_MODEL=true")
|
| 132 |
+
print()
|
| 133 |
+
|
| 134 |
+
return 0
|
| 135 |
+
|
| 136 |
+
|
| 137 |
+
if __name__ == "__main__":
|
| 138 |
+
sys.exit(main())
|