Wiself commited on
Commit
c71a692
·
verified ·
1 Parent(s): a3413a1

Upload DOCS.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. DOCS.md +68 -42
DOCS.md CHANGED
@@ -1,22 +1,24 @@
1
  # voice — Help
2
 
3
- Generated from `voice --help` and `voice <cmd> --help` (v3.0.1, 12 commands).
4
 
5
  ## voice --help
6
 
7
  ```text
8
  usage: voice [-h] [-v] [--non-interactive] [--version]
9
  [--completion {bash,zsh,fish}]
10
- {get,cast,delta,add,list,info,remove,cleanup,auth,report,path,doctor} ...
11
 
12
  Lift a model's voice and cast it onto another model.
13
 
14
  positional arguments:
15
- {get,cast,delta,add,list,info,remove,cleanup,auth,report,path,doctor}
16
  get Get a voice from a model (safetensors repo, .gguf, or
17
  URL)
18
  cast Cast a voice onto a .gguf or .safetensors file
19
  delta Make a reusable style (voice − base)
 
 
20
  add Add a voice from local voice.safetensors + voice.json
21
  list List stored voices
22
  info Show voice details
@@ -61,12 +63,6 @@ options:
61
  --yes Assume yes to prompts (overwrite without asking)
62
  ```
63
 
64
- Names: letters, numbers, hyphens, underscores — no spaces, `/`, `\`, dots,
65
- colons, and never starting with `delta-` (reserved). Stored lowercased
66
- (`StyleTune-V2` → `styletune-v2`). When no `--name` is given, the default is
67
- slugified from the source (`./my model.gguf` → `my-model`); an explicit
68
- `--name` that breaks the rules is an error.
69
-
70
  ## voice cast
71
 
72
  ```text
@@ -97,18 +93,6 @@ options:
97
  -q, --quiet Quieter: progress and success notes off (warnings and
98
  errors still print)
99
  ```
100
- Philosophy: preserve quality, avoid dequant→quant cycles. Safetensors high-fidelity
101
- lm_head is quantized once to Q8_0 (Q4 saves little: Q8_0 1.062 vs Q4_0 0.562 B/param).
102
- All GGML quants supported (trivial passthrough): Q8_0/Q4_0/Q4_1/Q5_0/Q5_1/Q8_1/Q8_K/
103
- Q1_0/Q2_K/Q3_K/Q4_K/Q5_K/Q6_K/IQ1_S/IQ1_M/IQ2_*/IQ3_*/IQ4_NL/IQ4_XS/TQ1_0/TQ2_0/MXFP4/NVFP4
104
- are kept at obtained quant (never upscale Q2→Q6, no inventing data). `--quant`
105
- accepts any quant name; encoding uses gguf lib where implemented (Q8_0/Q4_0/F16/F32/BF16).
106
- Unsupported quants (e.g. Q1_0/Q8_1/Q8_K where the lib raises NotImplemented) are a
107
- clear error naming the quant — pass `--quant keep` to preserve the original instead.
108
- Generic tensors keep target quant (F32 norms stay F32, never forced Q8_0).
109
- `--out` refuses to write through a symlink (path or parent dir). If the target
110
- architecture is unknown the output is labeled `llama` (GGUF requires an arch)
111
- with a warning. BF16 math uses round-to-nearest-even, not truncation.
112
 
113
  ## voice delta
114
 
@@ -126,10 +110,66 @@ options:
126
  still print)
127
  ```
128
 
129
- Niche cases need typed confirmation: delta-as-base asks `UNDO THE UNDO`,
130
- delta-on-delta asks `DOUBLE DIP`, delta-minus-delta asks `BIG BRAIN`.
131
- Non-interactive (`--yes`/pipe) fails fast with an error instead of prompting —
132
- re-run on a TTY to confirm.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
133
 
134
  ## voice add
135
 
@@ -148,10 +188,8 @@ options:
148
  still print)
149
  ```
150
 
151
- The tensor is copied and validated before `voice.json` is written, so an
152
- invalid source adds nothing and never leaves metadata pointing at a partial file.
153
-
154
  ## voice list
 
155
  ```text
156
  usage: voice list [-h] [--base] [-q] [base]
157
 
@@ -178,7 +216,9 @@ options:
178
  -q, --quiet Quieter: progress and success notes off (warnings and errors
179
  still print)
180
  ```
 
181
  ## voice remove
 
182
  ```text
183
  usage: voice remove [-h] [--yes] [-q] voice
184
 
@@ -238,13 +278,6 @@ options:
238
  errors still print)
239
  ```
240
 
241
- After local save (private `~/.voices/reports.jsonl`), shows preview:
242
- Will share: voice: styletune-v2, tensor: lm_head.weight [262144,2816] BF16, target: model.gguf
243
- Leave a breadcrumb to help the next person? [y/N] (N): ← Enter = No, one try
244
- Non-interactive skips unless --yes. Local: outbox at `~/.voices/outbox/<id>.json`.
245
- Remote: `Wiself/voice-reports` `data/reports-YYYY-MM.jsonl`, batched, dedup `report_id`.
246
- ```
247
-
248
  ## voice path
249
 
250
  ```text
@@ -266,10 +299,3 @@ options:
266
  -q, --quiet Quieter: progress and success notes off (warnings and errors
267
  still print)
268
  ```
269
-
270
- ## voice --version / --completion
271
-
272
- ```text
273
- voice --version # show version + environment
274
- voice --completion bash|zsh|fish # print shell completion
275
- ```
 
1
  # voice — Help
2
 
3
+ Generated from `voice --help` and `voice <cmd> --help` (v3.1, 14 commands).
4
 
5
  ## voice --help
6
 
7
  ```text
8
  usage: voice [-h] [-v] [--non-interactive] [--version]
9
  [--completion {bash,zsh,fish}]
10
+ {get,cast,delta,graft,chorus,add,list,info,remove,cleanup,auth,report,path,doctor} ...
11
 
12
  Lift a model's voice and cast it onto another model.
13
 
14
  positional arguments:
15
+ {get,cast,delta,graft,chorus,add,list,info,remove,cleanup,auth,report,path,doctor}
16
  get Get a voice from a model (safetensors repo, .gguf, or
17
  URL)
18
  cast Cast a voice onto a .gguf or .safetensors file
19
  delta Make a reusable style (voice − base)
20
+ graft Graft one voice onto another (DELLA single graft)
21
+ chorus Blend voices: pulse + support + lead (DELLA chorus)
22
  add Add a voice from local voice.safetensors + voice.json
23
  list List stored voices
24
  info Show voice details
 
63
  --yes Assume yes to prompts (overwrite without asking)
64
  ```
65
 
 
 
 
 
 
 
66
  ## voice cast
67
 
68
  ```text
 
93
  -q, --quiet Quieter: progress and success notes off (warnings and
94
  errors still print)
95
  ```
 
 
 
 
 
 
 
 
 
 
 
 
96
 
97
  ## voice delta
98
 
 
110
  still print)
111
  ```
112
 
113
+ ## voice graft
114
+
115
+ ```text
116
+ usage: voice graft [-h] [--density DENSITY] [--epsilon EPSILON]
117
+ [--lambda_ LAMBDA_] [--rescale {l1,inv_p}] [--seed SEED]
118
+ [--out OUT] [--yes] [-q]
119
+ [pulse] [donor]
120
+
121
+ positional arguments:
122
+ pulse Pulse voice name (default: pick from registry)
123
+ donor Donor voice name (default: pick from registry)
124
+
125
+ options:
126
+ -h, --help show this help message and exit
127
+ --density DENSITY Keep-fraction for magnitude pruning (default: 0.8)
128
+ --epsilon EPSILON Rank-ramp half-width (default: 0.1)
129
+ --lambda_ LAMBDA_ Global rescale after combine (default: 1.0)
130
+ --rescale {l1,inv_p} Prune rescale: l1 (stable) or inv_p (paper-faithful)
131
+ --seed SEED Bernoulli seed for reproducible grafts (default: 42)
132
+ --out OUT Output voice name (default: chorus-<pulse>-<donor>)
133
+ --yes Assume yes to prompts (overwrite without asking)
134
+ -q, --quiet Quieter: progress and success notes off (warnings and
135
+ errors still print)
136
+ ```
137
+
138
+ ## voice chorus
139
+
140
+ ```text
141
+ usage: voice chorus [-h] [--config] [--density DENSITY]
142
+ [--lead-density LEAD_DENSITY] [--epsilon EPSILON]
143
+ [--lead-epsilon LEAD_EPSILON] [--lambda_ LAMBDA_]
144
+ [--rescale {l1,inv_p}] [--seed SEED] [--out OUT] [--yes]
145
+ [-q]
146
+ [pulse] [donors ...]
147
+
148
+ positional arguments:
149
+ pulse Pulse voice name (default: pick interactively)
150
+ donors Support + lead voice names (0-2; 1 = duet at lead
151
+ density)
152
+
153
+ options:
154
+ -h, --help show this help message and exit
155
+ --config Stage knob screens per graft (Enter accepts each
156
+ default; screens prefill from flags)
157
+ --density DENSITY First-graft density (default: 0.8)
158
+ --lead-density LEAD_DENSITY
159
+ Lead-graft density (default: 0.9)
160
+ --epsilon EPSILON Rank-ramp half-width (default: 0.1)
161
+ --lead-epsilon LEAD_EPSILON
162
+ Lead-graft epsilon (default: 0.05; keeps 0.9±eps
163
+ valid)
164
+ --lambda_ LAMBDA_ Global rescale after combine (default: 1.0)
165
+ --rescale {l1,inv_p} Prune rescale: l1 (stable) or inv_p (paper-faithful)
166
+ --seed SEED Bernoulli seed for reproducible choruses (default: 42)
167
+ --out OUT Final output voice name (default:
168
+ chorus-<pulse>-<lead>)
169
+ --yes Assume yes to prompts (overwrite without asking)
170
+ -q, --quiet Quieter: progress and success notes off (warnings and
171
+ errors still print)
172
+ ```
173
 
174
  ## voice add
175
 
 
188
  still print)
189
  ```
190
 
 
 
 
191
  ## voice list
192
+
193
  ```text
194
  usage: voice list [-h] [--base] [-q] [base]
195
 
 
216
  -q, --quiet Quieter: progress and success notes off (warnings and errors
217
  still print)
218
  ```
219
+
220
  ## voice remove
221
+
222
  ```text
223
  usage: voice remove [-h] [--yes] [-q] voice
224
 
 
278
  errors still print)
279
  ```
280
 
 
 
 
 
 
 
 
281
  ## voice path
282
 
283
  ```text
 
299
  -q, --quiet Quieter: progress and success notes off (warnings and errors
300
  still print)
301
  ```