Derive the GMS manifest from modular block declarations

未关闭
#15,351 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
python, pytorch

调研方向

Start by reading the work in PR #15017 and the modular pipeline declarations, especially InputParam, _workflow_map, and save_pretrained(). The issue presents several design options and says the related PR is still WIP, so first check the current implementation and discussion for an agreed direction. Done means modular blocks can provide the manifest data and newly saved models include gms.json.

由索引模型根据 Issue 内容生成。

描述

#15017 adds diffusers serve, which describes a model with a manifest: its tasks, inputs, parameters and outputs.

Right now modular pipelines go through the same path as standard pipelines: the blocks are converted into a __call__-like signature, and the manifest is guessed from argument names and type hints. That makes sense for standard pipelines, where the signature is all we have. But modular blocks are declarative, and we shouldn't need to guess for our own pipelines. I think the blocks can state most of this directly. A few ideas to start with:

1. InputParam.metadata
InputParam already has a metadata dict (Mellon uses it). It could carry what the manifest needs:

  • the public name (num_inference_steps → steps)
  • the kind: text, image, video, audio, mask, or a plain setting
  • whether it's user-facing at all (latents, timesteps are not)

2. Tasks from workflows
Tasks are guessed from whether there's an image / video input, so a model gets at most two. Blocks already declare their workflows and trigger inputs in _workflow_map. One task per workflow would also cover workflows triggered by other inputs, e.g. references in MiniMax-H3.

3. Require type_hint on user-facing inputs
A parameter's schema comes from its type hint (int → integer, list[float] → array of numbers). An input without one can't be described and is dropped today. We could require a type_hint on every InputParam that's exposed, and check it in the tests.

4. Reuse it in save_pretrained()
If the manifest comes from the blocks alone, the same function can run in save_pretrained() and write a gms.json next to modular_model_index.json. serve already picks up a gms.json from the model repo, so new models would ship with their manifest.

What the code could look like
A made-up sketch to show the idea, not tested. The "gms" key and its fields are placeholders.

# in a block
InputParam("num_inference_steps", type_hint=int, default=28, metadata={"gms": {"name": "steps"}})
InputParam("image", type_hint=PIL.Image.Image, metadata={"gms": {"type": "image"}})
InputParam("latents", type_hint=torch.Tensor)  # no metadata, not exposed
def derive_manifest(model_id, blocks):
    tasks = {}
    for workflow, triggers in blocks._workflow_map.items():
        # the blocks that run for this workflow, so only its own inputs are listed
        workflow_blocks = blocks.get_workflow(workflow)

        inputs, parameters = {}, {}
        for param in workflow_blocks.inputs:
            gms = (param.metadata or {}).get("gms")
            if gms is None:  # not user-facing
                continue
            name = gms.get("name", param.name)

            if gms.get("type") in ("text", "image", "video", "audio", "mask"):
                inputs[name] = {"type": gms["type"], "required": param.required or param.name in triggers}
            else:
                schema = type_hint_to_schema(param.type_hint)  # int -> {"type": "integer"}
                if param.default is not None:
                    schema["default"] = param.default
                parameters[name] = schema

        tasks[workflow] = {"inputs": inputs, "parameters": parameters}

    return {"id": model_id, "tasks": tasks}

No rush since the PR is still WIP, opening this to collect ideas.

Posted by Claude on behalf of @yiyixuxu. The text was drafted together and approved by yiyixuxu.

主要语言
Python
星标
34.9k
派生
7.5k
平均合并
3 天 16 小时
30 天内合并 PR
65

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

huggingface/diffusers 的其他 Issue

查看 huggingface/diffusers 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。