@melite/models-yue2 0.1.4-alpha → 0.1.5-pre-alpha

package/README.md

@@ -0,0 +1,42 @@
+---
+description: YuE2 music family — YuE2-3B style-plus-lyrics song generation with ABC planning, on the ComfyUI engine from the official Comfy-Org release.
+kind: package-library
+---
+
+# @melite/models-yue2
+
+`@melite/models-yue2` is the model family package for YuE2-3B music generation (`form_music`, genre audio, engine comfyui): a style caption plus lyrics go in, an ABC plan is drafted, and a song comes out as mp3. The DECL boards the official Comfy-Org release (`Comfy-Org/YuE2`, the `audio_yue2_text2music` template) and declares the `compose` action, one provision, and the required `prompt` relation. The estate boot mounts it as a Cordis plugin through `ctx.models.registerFamily` inside `ctx.effect`; the music card binds the action. The lane is this package's own `actions.ts`, pinned to committed goldens in `tests/golden/`.
+
+## Declaration
+
+One checkpoint carries model, clip, and VAE (`yue2_3b_int8_convrot.safetensors`, provisioned from Comfy-Org at ~3.96 GB, sha256-pinned; the INT8 ConvRot cell declares an ~8 GB VRAM peak). Variant recipes: `short_sting` stamps `duration` 5 (the schema floor) and `full_length` stamps 360 (the ceiling); `Default` stamps nothing. The `compose` action's params: `prompt` (required — every music lane states what the song is), `lyrics`, `mode` (`full` / `melody` / `off`), `duration` (bounds 5–360), `n_diffusion_steps` (1–200), and a seed-sentinel `seed`. The build plans ABC with `YuE2GenerateABC` (mode `off` composes no planner), sizes the latent from `YuE2GenerateMusic`'s seconds output, samples with KSampler dpm_2 / sgm_uniform at cfg 1, and saves mp3 V0 under `<run>/music`.
+
+```
+.
+./package.json
+```
+
+## Model Experience
+
+### Request context and condition
+
+#### What the model sees
+
+- **prompt** — required; the style caption.
+- **lyrics** — the sung words (absent rides as empty).
+- **mode** — the ABC-planning pick.
+- **duration / n_diffusion_steps / seed** — length, sampler depth, and the minted seed.
+
+#### Token effect
+
+Zero-direct token effect — the fields ride the composed ComfyUI graph; the caption and lyrics are engine-side, never harness context.
+
+#### KV Cache effect
+
+Independent — each composition is its own engine request; no shared prefix.
+
+## Known Limitations and Deferred Work
+
+- **One quant boarded** — only the INT8 ConvRot cell exists; the bf16 cell and the SheetSage2 cover encoder stay unboarded until a cover lane exists (the DECL's own source note).
+- **Guidance is fixed** — cfg rides at 1 by design (guidance lives on the AR side); there is no cfg knob.
+- **Song quality** — musicality and lyric adherence are not verified against the running model.

package/lib/index.d.ts

@@ -1,6 +1,7 @@
 import type { Plugin } from "@deepseek-ai/cordis";
-import type { ModelDecl } from "@melite/comfyui-cordis/model-contract";
+import type { ModelDecl } from '@melite/comfyui-card-kit/model-contract';
 export declare const DECL: ModelDecl;
 export declare const family: Plugin;
 export { compose, parseYue2Facts, type Yue2Facts, type Yue2Params } from "./actions.js";
+export { family as default };
 //# sourceMappingURL=index.d.ts.map

package/lib/index.js

@@ -19,9 +19,8 @@ export const DECL = {
             "route": "yue2",
             "cells": [
                 {
-                    "source": {
-                        "filename": "YuE2"
-                    },
+                    
+                    // Comfy-Org checkpoint the provisions row carries.
                     "quant": "int8",
                     "label": "INT8 ConvRot",
                     "route": "yue2",
@@ -95,6 +94,12 @@ export const DECL = {
             },
         ],
     },
+    // THE LANE SURFACE (the z-image precedent): exactly the knobs the
+    // music card serves.
+    "params": [
+        "prompt", "lyrics", "duration", "mode",
+        "guidance_scale", "n_diffusion_steps", "lm_cfg_scale", "seed",
+    ],
     // THE DECLARED ACTIONS (the atom vocabulary, stroke 3):
     // the compose action the music card binds (the YuE2-3B lane).
     // The admission gate runs the facts parse at registration.
@@ -108,4 +113,9 @@ export const family = {
     },
 };
 export { compose, parseYue2Facts } from "./actions.js";
+// The Loader-row face: DSH loads plugin rows by bare specifier and
+// unwraps `exports.default ?? exports` (vendor/cordis_plugins/loader
+// unwrapExports) — the default export IS the row-loadable plugin. The
+// named `family` stays the library face (engine loadFamilies).
+export { family as default };
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@melite/models-yue2",
-  "version": "0.1.4-alpha",
+  "version": "0.1.5-pre-alpha",
   "license": "SSPL-1.0",
   "type": "module",
   "exports": {
@@ -11,8 +11,7 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@melite/comfyui-card-kit": "0.1.4-alpha",
-    "@melite/comfyui-cordis": "0.1.4-alpha"
+    "@melite/comfyui-card-kit": "0.1.5-pre-alpha"
   },
   "devDependencies": {
     "@types/node": "^22.20.0",