Upload USAGE_GUIDE.md with huggingface_hub
Browse files- USAGE_GUIDE.md +247 -0
USAGE_GUIDE.md
ADDED
|
@@ -0,0 +1,247 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# 📖 Руководство по использованию
|
| 2 |
+
|
| 3 |
+
## 🎯 Цель
|
| 4 |
+
|
| 5 |
+
Этот Space автоматизирует процесс конвертации моделей из safetensors в Diffusers формат.
|
| 6 |
+
|
| 7 |
+
---
|
| 8 |
+
|
| 9 |
+
## 🚀 Быстрый старт
|
| 10 |
+
|
| 11 |
+
### Web UI
|
| 12 |
+
|
| 13 |
+
1. **Откройте Space**: https://huggingface.co/spaces/Gerchegg/Qwen-Model-Converter
|
| 14 |
+
2. **Заполните форму**:
|
| 15 |
+
```
|
| 16 |
+
Source Repo: Gerchegg/QwenSolobandModel
|
| 17 |
+
Source File: Qwen_Soloband_Model_V1-000140.safetensors
|
| 18 |
+
Base Model: Qwen/Qwen-Image
|
| 19 |
+
Target Repo: YourUsername/YourModel-Diffusers
|
| 20 |
+
HF Token: hf_your_token_here
|
| 21 |
+
```
|
| 22 |
+
3. **Нажмите "Запустить конвертацию"**
|
| 23 |
+
4. **Дождитесь завершения** (~45-90 минут)
|
| 24 |
+
|
| 25 |
+
---
|
| 26 |
+
|
| 27 |
+
## 🔌 API Использование
|
| 28 |
+
|
| 29 |
+
### Python
|
| 30 |
+
|
| 31 |
+
```python
|
| 32 |
+
from gradio_client import Client
|
| 33 |
+
|
| 34 |
+
client = Client("Gerchegg/Qwen-Model-Converter")
|
| 35 |
+
|
| 36 |
+
# Запуск конвертации
|
| 37 |
+
result = client.predict(
|
| 38 |
+
source_repo_id="Gerchegg/QwenSolobandModel",
|
| 39 |
+
source_filename="Qwen_Soloband_Model_V1-000140.safetensors",
|
| 40 |
+
base_model_id="Qwen/Qwen-Image",
|
| 41 |
+
target_repo_id="YourUsername/YourModel-Diffusers",
|
| 42 |
+
hf_token="hf_your_token_here",
|
| 43 |
+
api_name="/convert"
|
| 44 |
+
)
|
| 45 |
+
|
| 46 |
+
status, logs = result
|
| 47 |
+
|
| 48 |
+
print(status) # ✅ Готово! URL: https://...
|
| 49 |
+
print(logs) # Подробные логи процесса
|
| 50 |
+
```
|
| 51 |
+
|
| 52 |
+
### JavaScript (Node.js)
|
| 53 |
+
|
| 54 |
+
```javascript
|
| 55 |
+
import { client } from "@gradio/client";
|
| 56 |
+
|
| 57 |
+
const app = await client("Gerchegg/Qwen-Model-Converter");
|
| 58 |
+
|
| 59 |
+
const result = await app.predict("/convert", {
|
| 60 |
+
source_repo_id: "Gerchegg/QwenSolobandModel",
|
| 61 |
+
source_filename: "Qwen_Soloband_Model_V1-000140.safetensors",
|
| 62 |
+
base_model_id: "Qwen/Qwen-Image",
|
| 63 |
+
target_repo_id: "YourUsername/YourModel-Diffusers",
|
| 64 |
+
hf_token: "hf_your_token_here"
|
| 65 |
+
});
|
| 66 |
+
|
| 67 |
+
console.log(result.data);
|
| 68 |
+
```
|
| 69 |
+
|
| 70 |
+
### cURL
|
| 71 |
+
|
| 72 |
+
```bash
|
| 73 |
+
curl -X POST "https://gerchegg-qwen-model-converter.hf.space/api/predict" \
|
| 74 |
+
-H "Content-Type: application/json" \
|
| 75 |
+
-d '{
|
| 76 |
+
"data": [
|
| 77 |
+
"Gerchegg/QwenSolobandModel",
|
| 78 |
+
"Qwen_Soloband_Model_V1-000140.safetensors",
|
| 79 |
+
"Qwen/Qwen-Image",
|
| 80 |
+
"YourUsername/YourModel-Diffusers",
|
| 81 |
+
"hf_your_token_here"
|
| 82 |
+
]
|
| 83 |
+
}'
|
| 84 |
+
```
|
| 85 |
+
|
| 86 |
+
---
|
| 87 |
+
|
| 88 |
+
## 📊 Примеры конвертации
|
| 89 |
+
|
| 90 |
+
### Пример 1: Стандартная Qwen модель
|
| 91 |
+
|
| 92 |
+
```python
|
| 93 |
+
source_repo_id = "Gerchegg/QwenSolobandModel"
|
| 94 |
+
source_filename = "Qwen_Soloband_Model_V1-000140.safetensors"
|
| 95 |
+
base_model_id = "Qwen/Qwen-Image"
|
| 96 |
+
target_repo_id = "Gerchegg/Qwen-Soloband-Diffusers"
|
| 97 |
+
```
|
| 98 |
+
|
| 99 |
+
**Время**: ~60 минут
|
| 100 |
+
**Размер**: ~58GB (40GB transformer + 18GB компоненты)
|
| 101 |
+
|
| 102 |
+
---
|
| 103 |
+
|
| 104 |
+
### Пример 2: Кастомная модель
|
| 105 |
+
|
| 106 |
+
```python
|
| 107 |
+
source_repo_id = "YourUsername/CustomQwenModel"
|
| 108 |
+
source_filename = "custom_transformer.safetensors"
|
| 109 |
+
base_model_id = "Qwen/Qwen-Image"
|
| 110 |
+
target_repo_id = "YourUsername/CustomModel-Diffusers"
|
| 111 |
+
```
|
| 112 |
+
|
| 113 |
+
---
|
| 114 |
+
|
| 115 |
+
### Пример 3: Fine-tuned модель
|
| 116 |
+
|
| 117 |
+
```python
|
| 118 |
+
source_repo_id = "Community/FineTunedQwen"
|
| 119 |
+
source_filename = "checkpoint-1000.safetensors"
|
| 120 |
+
base_model_id = "Qwen/Qwen-Image"
|
| 121 |
+
target_repo_id = "YourUsername/FineTuned-Diffusers"
|
| 122 |
+
```
|
| 123 |
+
|
| 124 |
+
---
|
| 125 |
+
|
| 126 |
+
## ⏱️ Время выполнения
|
| 127 |
+
|
| 128 |
+
| Этап | Время | Зависит от |
|
| 129 |
+
|------|-------|------------|
|
| 130 |
+
| **Скачивание safetensors** | 5-15 мин | Размер файла, интернет |
|
| 131 |
+
| **Скачивание базовой модели** | 5-10 мин | Первый раз дольше, затем кэш |
|
| 132 |
+
| **Конвертация** | 1-3 мин | Размер модели |
|
| 133 |
+
| **Загрузка на HF** | 30-90 мин | Размер, скорость upload |
|
| 134 |
+
| **Итого** | **45-120 мин** | Для модели ~40GB |
|
| 135 |
+
|
| 136 |
+
---
|
| 137 |
+
|
| 138 |
+
## 💾 Требования к памяти
|
| 139 |
+
|
| 140 |
+
### Во время процесса:
|
| 141 |
+
|
| 142 |
+
| Компонент | Размер | Примечание |
|
| 143 |
+
|-----------|--------|------------|
|
| 144 |
+
| Safetensors (скачан) | ~40GB | Временный |
|
| 145 |
+
| Базовая модель | ~18GB | Кэшируется |
|
| 146 |
+
| Diffusers (выход) | ~58GB | Результат |
|
| 147 |
+
| **Peak usage** | **~70GB** | Temporary + Output |
|
| 148 |
+
|
| 149 |
+
**Примечание**: Space на HuggingFace имеет достаточно места для обработки больших моделей.
|
| 150 |
+
|
| 151 |
+
---
|
| 152 |
+
|
| 153 |
+
## 🔐 HuggingFace Token
|
| 154 |
+
|
| 155 |
+
### Требуемые права:
|
| 156 |
+
|
| 157 |
+
✅ **Read** - для скачивания source и base моделей
|
| 158 |
+
✅ **Write** - для создания и загрузки в target репозиторий
|
| 159 |
+
|
| 160 |
+
### Создание токена:
|
| 161 |
+
|
| 162 |
+
1. Перейдите: https://huggingface.co/settings/tokens
|
| 163 |
+
2. Нажмите "New token"
|
| 164 |
+
3. Выберите тип: **Write**
|
| 165 |
+
4. Скопируйте токен (начинается с `hf_`)
|
| 166 |
+
|
| 167 |
+
---
|
| 168 |
+
|
| 169 |
+
## 📝 Подробные логи
|
| 170 |
+
|
| 171 |
+
Во время конвертации Space показывает подробные логи:
|
| 172 |
+
|
| 173 |
+
```
|
| 174 |
+
[12:00:01] 🚀 Начало процесса конвертации
|
| 175 |
+
[12:00:01] Source: Gerchegg/QwenSolobandModel/Qwen_Soloband_Model_V1-000140.safetensors
|
| 176 |
+
[12:00:01] Base: Qwen/Qwen-Image
|
| 177 |
+
[12:00:01] Target: YourUsername/Model-Diffusers
|
| 178 |
+
[12:00:01]
|
| 179 |
+
[12:00:01] ============================================================
|
| 180 |
+
[12:00:01] ШАГ 1: Скачивание safetensors модели
|
| 181 |
+
[12:00:01] ============================================================
|
| 182 |
+
[12:08:32] ✓ Safetensors скачан: 40.9 GB
|
| 183 |
+
[12:08:32]
|
| 184 |
+
[12:08:32] ============================================================
|
| 185 |
+
[12:08:32] ШАГ 2: Скачивание базовой модели
|
| 186 |
+
[12:08:32] ============================================================
|
| 187 |
+
[12:15:45] ✓ Базовая модель скачана
|
| 188 |
+
[12:15:45]
|
| 189 |
+
[12:15:45] ============================================================
|
| 190 |
+
[12:15:45] ШАГ 3: Конвертация в Diffusers формат
|
| 191 |
+
[12:15:45] ============================================================
|
| 192 |
+
[12:17:20] ✓ Модель конвертирована: 58.3 GB
|
| 193 |
+
[12:17:20] Путь: workspace/output/Model-Diffusers
|
| 194 |
+
[12:17:20]
|
| 195 |
+
[12:17:20] ============================================================
|
| 196 |
+
[12:17:20] ШАГ 4: Загрузка на HuggingFace Hub
|
| 197 |
+
[12:17:20] ============================================================
|
| 198 |
+
[12:17:20] ⏳ Это может занять 30-60 минут для больших моделей...
|
| 199 |
+
[12:17:20]
|
| 200 |
+
[13:05:42] ✓ Модель загружена на HuggingFace!
|
| 201 |
+
[13:05:42] URL: https://huggingface.co/YourUsername/Model-Diffusers
|
| 202 |
+
[13:05:42]
|
| 203 |
+
[13:05:42] ============================================================
|
| 204 |
+
[13:05:42] ✅ ПРОЦЕСС ЗАВЕРШЕН УСПЕШНО!
|
| 205 |
+
[13:05:42] ============================================================
|
| 206 |
+
```
|
| 207 |
+
|
| 208 |
+
---
|
| 209 |
+
|
| 210 |
+
## 🐛 Troubleshooting
|
| 211 |
+
|
| 212 |
+
### Проблема: "Invalid HF Token"
|
| 213 |
+
|
| 214 |
+
**Решение**:
|
| 215 |
+
- Убедитесь что токен начинается с `hf_`
|
| 216 |
+
- Проверьте права токена (должен быть Write)
|
| 217 |
+
- Создайте новый токен если нужно
|
| 218 |
+
|
| 219 |
+
### Проблема: "File not found"
|
| 220 |
+
|
| 221 |
+
**Решение**:
|
| 222 |
+
- Проверьте правильность написания repo_id
|
| 223 |
+
- Проверьте правильность имени файла
|
| 224 |
+
- Убедитесь что токен имеет доступ к source репо
|
| 225 |
+
|
| 226 |
+
### Проблема: "Out of space"
|
| 227 |
+
|
| 228 |
+
**Решение**:
|
| 229 |
+
- Space на HF имеет достаточно места
|
| 230 |
+
- Если проблема - сообщите в discussions
|
| 231 |
+
- Попробуйте позже
|
| 232 |
+
|
| 233 |
+
### Проблема: "Upload failed"
|
| 234 |
+
|
| 235 |
+
**Решение**:
|
| 236 |
+
- HF API автоматически возобновляет загрузку
|
| 237 |
+
- Просто перезапустите конвертацию
|
| 238 |
+
- Загрузка продолжится с места остановки
|
| 239 |
+
|
| 240 |
+
---
|
| 241 |
+
|
| 242 |
+
## 📚 Дополнительные ресурсы
|
| 243 |
+
|
| 244 |
+
- [Diffusers Documentation](https://huggingface.co/docs/diffusers)
|
| 245 |
+
- [HuggingFace Hub Guide](https://huggingface.co/docs/hub)
|
| 246 |
+
- [Safetensors Format](https://huggingface.co/docs/safetensors)
|
| 247 |
+
|