Как написать встроенное знание
Встроенные знания позволяют холсту объяснять основы до того, как настроена какая-либо модель: что делает базовая нода, что несёт тип связи, что нужно семейству моделей. Они написаны вручную по-английски и по-русски.
Где они
| Что | Где |
|---|---|
| Списки того, что охвачено | src/shared/knowledge/coreKnowledge.ts: CORE_NODE_CLASSES, CORE_LINK_TYPES, CORE_FAMILIES и ссылки на официальную документацию ComfyUI (CORE_NODE_DOCS). |
| Тексты | coreKnowledge.en.ts и coreKnowledge.ru.ts: nodes, linkTypes, families. |
| В базу | src/main/knowledge/seedCore.ts записывает их как объяснения на языке интерфейса и переписывает, когда язык меняется. |
| Семейства моделей | src/shared/knowledge/baseModel.ts (как распознаётся семейство файла), modelKind.ts. |
Форма
- Нода или тип связи:
what(что это),why(зачем используется),connect(что входит и выходит) и необязательныйrisk(частая ошибка). - Семейство: что это, какие загрузчики нужны и в чём ловушка совместимости.
Правила
- Сначала правда.
whatиconnectописывают обычное поведение ComfyUI и показываются как факт, со ссылкой на официальную страницу документации, если она есть (каждый адрес сверен сdocs.comfy.org).whyиriskэто совет, они показываются как догадка. Заметка о семействе считается фактом, только если названные в ней части подтверждает официальное руководство. - Оба языка, одни и те же пункты. Русский текст по-русски, английский без кириллицы; одинаковые необязательные
заметки
riskв обоих. - Коротко. Карточка-описание показывает первую строку; вкладка «Объяснение» показывает остальное.
- Никаких секретов, названий моделей чат-помощников и ссылок за пределы
docs.comfy.org.
Как добавить ноду, тип или семейство
- Добавьте id в список в
coreKnowledge.ts(имя класса так, как его пишет ComfyUI). - Добавьте тексты в
coreKnowledge.en.tsиcoreKnowledge.ru.ts. - Добавьте ссылку на документацию или
null, если её нет. - Запустите
npx vitest run tests/unit/coreKnowledge.test.ts: он проверяет каждый пункт на обоих языках, язык каждого текста, ссылки и то, как помечен каждый текст. - Если страница вики объясняет то же самое (
docs/wiki/concepts/), следите, чтобы они говорили одно и то же.