msrcam commited on
Commit
6fcbfb5
Β·
verified Β·
1 Parent(s): 82de312

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +0 -148
README.md CHANGED
@@ -1,148 +0,0 @@
1
- ---
2
- license: apache-2.0
3
- ---
4
-
5
- # msrcam/ComfyUI_Models
6
-
7
- ## 🚨 NAMING & ORGANIZATION RULES - READ THIS FIRST 🚨
8
-
9
- ### File Naming Convention
10
- ```
11
- {model-name}-{version}-{precision}.safetensors
12
- ```
13
- Examples:
14
- - `fluxed-up-7.1-fp16.safetensors`
15
- - `flux-capacity-5.0-fp16.safetensors`
16
- - `persephone-1.2-fp16.safetensors`
17
- - `perfection-cinematic-3.1-fp16.safetensors`
18
-
19
- ### Folder Structure
20
- ```
21
- msrcam/ComfyUI_Models/
22
- β”œβ”€β”€ checkpoints/
23
- β”‚ β”œβ”€β”€ flux/ # Flux.1 Dev checkpoints
24
- β”‚ β”‚ β”œβ”€β”€ fluxed-up-7.1-fp16.safetensors
25
- β”‚ β”‚ β”œβ”€β”€ flux-capacity-5.0-fp16.safetensors
26
- β”‚ β”‚ └── persephone-1.2-fp16.safetensors
27
- β”‚ └── illustrious/ # Illustrious XL checkpoints
28
- β”‚ └── perfection-cinematic-3.1-fp16.safetensors
29
- β”œβ”€β”€ loras/
30
- β”‚ β”œβ”€β”€ flux1dev/ # Flux.1 Dev LoRAs (prefix: flux1dev_)
31
- β”‚ β”œβ”€β”€ flux2klein/ # Flux.2 Klein LoRAs (prefix: flux2klein_)
32
- β”‚ β”œβ”€β”€ flux1kontext/ # Flux.1 Kontext LoRAs (prefix: flux1kontext_)
33
- β”‚ └── kontext/ # Kontext utility LoRAs
34
- β”œβ”€β”€ clip/
35
- β”œβ”€β”€ controlnet/
36
- β”œβ”€β”€ detection/
37
- β”œβ”€β”€ facerestore/
38
- β”œβ”€β”€ insightface/
39
- β”‚ └── buffalo_l/
40
- β”œβ”€β”€ ipadapter/
41
- β”œβ”€β”€ swappers/
42
- └── upscalers/
43
- ```
44
-
45
- ---
46
-
47
- ## MASTER DOWNLOAD & UPLOAD COMMAND
48
-
49
- ### For Civitai Checkpoints:
50
- ```bash
51
- # TEMPLATE - Replace values in {}
52
- cd /tmp/civitai_mirror
53
-
54
- # Download
55
- aria2c -x 16 -s 16 -o {model-name}-{version}-fp16.safetensors \
56
- "https://civitai.com/api/download/models/{MODEL_ID}?type=Model&format=SafeTensor&size=pruned&fp=fp16&token={CIVITAI_TOKEN}"
57
-
58
- # Verify size
59
- ls -lh {model-name}-{version}-fp16.safetensors
60
-
61
- # Upload to correct category folder
62
- hf upload msrcam/ComfyUI_Models {model-name}-{version}-fp16.safetensors checkpoints/{category}/{model-name}-{version}-fp16.safetensors --repo-type model --token {HF_WRITE_TOKEN}
63
- ```
64
-
65
- ### Categories:
66
- | Model Type | Category Folder |
67
- |------------|-----------------|
68
- | Flux.1 Dev | `checkpoints/flux/` |
69
- | Flux.2 Klein | `checkpoints/flux2klein/` |
70
- | Illustrious XL | `checkpoints/illustrious/` |
71
- | SDXL | `checkpoints/sdxl/` |
72
- | SD 1.5 | `checkpoints/sd15/` |
73
- | Pony | `checkpoints/pony/` |
74
-
75
- ---
76
-
77
- ## EXAMPLE COMMANDS
78
-
79
- ### Flux Checkpoint:
80
- ```bash
81
- aria2c -x 16 -s 16 -o fluxed-up-7.1-fp16.safetensors \
82
- "https://civitai.com/api/download/models/2577735?type=Model&format=SafeTensor&size=pruned&fp=fp16&token={CIVITAI_TOKEN}"
83
-
84
- hf upload msrcam/ComfyUI_Models fluxed-up-7.1-fp16.safetensors checkpoints/flux/fluxed-up-7.1-fp16.safetensors --repo-type model --token {HF_WRITE_TOKEN}
85
- ```
86
-
87
- ### Illustrious Checkpoint:
88
- ```bash
89
- aria2c -x 16 -s 16 -o perfection-cinematic-3.1-fp16.safetensors \
90
- "https://civitai.com/api/download/models/2600793?type=Model&format=SafeTensor&size=pruned&fp=fp16&token={CIVITAI_TOKEN}"
91
-
92
- hf upload msrcam/ComfyUI_Models perfection-cinematic-3.1-fp16.safetensors checkpoints/illustrious/perfection-cinematic-3.1-fp16.safetensors --repo-type model --token {HF_WRITE_TOKEN}
93
- ```
94
-
95
- ### LoRA Upload:
96
- ```bash
97
- # Flux.1 Dev LoRA
98
- hf upload msrcam/ComfyUI_Models flux1dev_whatever.safetensors loras/flux1dev/flux1dev_whatever.safetensors --repo-type model --token {HF_WRITE_TOKEN}
99
-
100
- # Flux.2 Klein LoRA
101
- hf upload msrcam/ComfyUI_Models flux2klein_whatever.safetensors loras/flux2klein/flux2klein_whatever.safetensors --repo-type model --token {HF_WRITE_TOKEN}
102
- ```
103
-
104
- ### Other Models (detection, upscalers, etc):
105
- ```bash
106
- # Face detection
107
- hf upload msrcam/ComfyUI_Models face_yolov8m.pt detection/face_yolov8m.pt --repo-type model --token {HF_WRITE_TOKEN}
108
-
109
- # Upscaler
110
- hf upload msrcam/ComfyUI_Models 4x-UltraSharp.pth upscalers/4x-UltraSharp.pth --repo-type model --token {HF_WRITE_TOKEN}
111
-
112
- # Face restore
113
- hf upload msrcam/ComfyUI_Models codeformer.pth facerestore/codeformer.pth --repo-type model --token {HF_WRITE_TOKEN}
114
- ```
115
-
116
- ---
117
-
118
- ## MOVE FILES (Reorganize existing files)
119
- ```bash
120
- python3 << 'PYTHON'
121
- from huggingface_hub import HfApi
122
- api = HfApi(token="{HF_WRITE_TOKEN}")
123
- api.move_repo_file(
124
- path_in_repo="old/path/file.safetensors",
125
- new_path="new/path/file.safetensors",
126
- repo_id="msrcam/ComfyUI_Models",
127
- repo_type="model"
128
- )
129
- PYTHON
130
- ```
131
-
132
- ## DELETE FILES
133
- ```bash
134
- python3 << 'PYTHON'
135
- from huggingface_hub import HfApi
136
- api = HfApi(token="{HF_WRITE_TOKEN}")
137
- api.delete_file("path/to/file.safetensors", "msrcam/ComfyUI_Models", repo_type="model")
138
- PYTHON
139
- ```
140
-
141
- ---
142
-
143
- ## DO NOT
144
- - ❌ Put checkpoints in root of checkpoints/ - USE CATEGORY FOLDERS
145
- - ❌ Forget version number in filename
146
- - ❌ Forget precision (fp16/fp8) in filename
147
- - ❌ Mix model types in same folder
148
- - ❌ Upload without checking file size first (ls -lh)