Skip to content

Commit 4a9da27

Browse files
Various clean-up and fixes of markdown linting issues (#15)
* Markdown linting for Canny node * Add shell script to fix markdown linting issues. * Various clean-up and fixes or markdown linting issues. * Standardize Inputs and Outputs titles for ja.md files. * Standardize Inputs and Outputs titles for ko.md files. * Standardize Inputs and Outputs titles for zh.md files. * Fix output and input titles, update documentation for Note node and add documentation for MarkdownNote node. * Standardize "Comfy dtype" into "Data Type". * Standardize columns headers for inputs and outputs * Update README to add linting section. * Remove exta folder ImageToMask copy * Add bash script to run linting. * Update linting section in README.
1 parent c671dd1 commit 4a9da27

File tree

819 files changed

+4643
-4144
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

819 files changed

+4643
-4144
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# comfyui_embedded_docs
22

33
> [!NOTE]
4-
> This is only for core nodes. For embedded custom node documentation, please see https://docs.comfy.org/custom-nodes/help_page
4+
> This is only for core nodes. For embedded custom node documentation, please see <https://docs.comfy.org/custom-nodes/help_page>
55
66
## Updating Documentation
77

@@ -17,6 +17,7 @@ See [FluxProUltraImageNode](https://github.com/Comfy-Org/embedded-docs/tree/main
1717
To preview your documentation changes in ComfyUI:
1818

1919
1. **Install editable version (optional but recommended):**
20+
2021
```bash
2122
# If you have one, activate your ComfyUI virtual environment first
2223
pip uninstall comfyui-embedded-docs # Remove existing PyPI version
@@ -33,10 +34,29 @@ To preview your documentation changes in ComfyUI:
3334
## Publishing
3435

3536
The package is automatically published to PyPI when:
37+
3638
1. You manually trigger the workflow (Actions → Publish to PyPI → Run workflow)
3739
2. You push changes to `pyproject.toml` on the main branch
3840
3. A pull request that modifies `pyproject.toml` is merged to main
3941

4042
The publishing workflow:
43+
4144
1. Builds the package using `python -m build`
42-
2. Publishes to PyPI using the configured PYPI_TOKEN secret
45+
2. Publishes to PyPI using the configured PYPI_TOKEN secret
46+
47+
## Linting
48+
49+
To ensure minimal consistency across nodes documentation, it is recommended to follow the Markdown linting principles. Some of the linting issues can be fixed automatically with the shell script below. Note this requires to install `markdownlint-cli`.
50+
51+
```sh
52+
# Install markdownlint-cli
53+
# If you encounter the error npm.ps1 cannot be loaded because running scripts is disabled on this system
54+
# Run this command: Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
55+
npm install -g markdownlint-cli
56+
57+
# Fix linting issues in markdown files, using shell script (Linux)
58+
bash fix_markdown.sh
59+
60+
# Or fix linting issues in markdown files, using powershell script (Windows)
61+
powershell -ExecutionPolicy Bypass -File fix_markdown.ps1
62+
```

comfyui_embedded_docs/docs/BasicScheduler/en.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
The `BasicScheduler` node is designed to compute a sequence of sigma values for diffusion models based on the provided scheduler, model, and denoising parameters. It dynamically adjusts the total number of steps based on the denoise factor to fine-tune the diffusion process, providing precise "recipes" for different stages in advanced sampling processes that require fine control (such as multi-stage sampling).
22

3-
## Input Parameters
3+
## Inputs
44

5-
| Parameter | Data Type | Input Type | Default | Range | Metaphor Description | Technical Purpose |
6-
| ----------- | ------------- | ---------- | ------- | -------- | ------------------------------ | ---------------------------- |
7-
| `model` | MODEL | Input | - | - | **Canvas Type**: Different canvas materials need different paint formulas | Diffusion model object, determines sigma calculation basis |
8-
| `scheduler` | COMBO[STRING] | Widget | - | 9 options | **Mixing Technique**: Choose how paint concentration changes | Scheduling algorithm, controls noise decay mode |
9-
| `steps` | INT | Widget | 20 | 1-10000 | **Mixing Count**: 20 mixes vs 50 mixes precision difference | Sampling steps, affects generation quality and speed |
10-
| `denoise` | FLOAT | Widget | 1.0 | 0.0-1.0 | **Creation Intensity**: Control level from fine-tuning to repainting | Denoising strength, supports partial repainting scenarios |
5+
| Parameter | Data Type | Input Type | Default | Range | Metaphor Description | Technical Purpose |
6+
| ----------- | ------------- | ---------- | ------- | --------- | ------------------------------ | ---------------------------- |
7+
| `model` | MODEL | Input | - | - | **Canvas Type**: Different canvas materials need different paint formulas | Diffusion model object, determines sigma calculation basis |
8+
| `scheduler` | COMBO[STRING] | Widget | - | 9 options | **Mixing Technique**: Choose how paint concentration changes | Scheduling algorithm, controls noise decay mode |
9+
| `steps` | INT | Widget | 20 | 1-10000 | **Mixing Count**: 20 mixes vs 50 mixes precision difference | Sampling steps, affects generation quality and speed |
10+
| `denoise` | FLOAT | Widget | 1.0 | 0.0-1.0 | **Creation Intensity**: Control level from fine-tuning to repainting | Denoising strength, supports partial repainting scenarios |
1111

1212
### Scheduler Types
1313

@@ -25,18 +25,18 @@ Based on source code `comfy.samplers.SCHEDULER_NAMES`, supports the following 9
2525
| **linear_quadratic** | Linear quadratic | Complex scenario optimization| Quadratic function decay |
2626
| **kl_optimal** | KL optimal | Theoretical optimization | KL divergence optimized decay|
2727

28-
## Output Results
28+
## Outputs
2929

3030
| Parameter | Data Type | Output Type | Metaphor Description | Technical Meaning |
3131
| --------- | --------- | ----------- | ---------------------- | -------------------------------- |
3232
| `sigmas` | SIGMAS | Output | **Paint Recipe Chart**: Detailed paint concentration list for step-by-step use | Noise level sequence, guides diffusion model denoising process |
3333

34-
3534
## Node Role: Artist's Color Mixing Assistant
3635

3736
Imagine you are an artist creating a clear image from a chaotic mixture of paint (noise). `BasicScheduler` acts like your **professional color mixing assistant**, whose job is to prepare a series of precise paint concentration recipes:
3837

3938
### Workflow
39+
4040
- **Step 1**: Use 90% concentration paint (high noise level)
4141
- **Step 2**: Use 80% concentration paint
4242
- **Step 3**: Use 70% concentration paint
@@ -46,18 +46,22 @@ Imagine you are an artist creating a clear image from a chaotic mixture of paint
4646
### Color Assistant's Special Skills
4747

4848
**Different mixing methods (scheduler)**:
49+
4950
- **"karras" mixing method**: Paint concentration changes very smoothly, like professional artist's gradient technique
5051
- **"exponential" mixing method**: Paint concentration decreases rapidly, suitable for quick creation
5152
- **"linear" mixing method**: Paint concentration decreases uniformly, stable and controllable
5253

5354
**Fine control (steps)**:
55+
5456
- **20 mixes**: Quick painting, efficiency priority
5557
- **50 mixes**: Fine painting, quality priority
5658

5759
**Creation intensity (denoise)**:
60+
5861
- **1.0 = Complete new creation**: Start completely from blank canvas
5962
- **0.5 = Half transformation**: Keep half of original painting, transform half
6063
- **0.2 = Fine adjustment**: Only make subtle adjustments to original painting
6164

6265
### Collaboration with Other Nodes
63-
`BasicScheduler` (Color Assistant) → Prepare Recipe → `SamplerCustom` (Artist) → Actual Painting → Completed Work
66+
67+
`BasicScheduler` (Color Assistant) → Prepare Recipe → `SamplerCustom` (Artist) → Actual Painting → Completed Work

comfyui_embedded_docs/docs/BasicScheduler/es.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
El nodo `ProgramadorBásico` está diseñado para calcular una secuencia de valores sigma para modelos de difusión basados en el programador, modelo y parámetros de reducción de ruido proporcionados. Ajusta dinámicamente el número total de pasos según el factor de reducción de ruido para afinar el proceso de difusión, proporcionando "recetas" precisas para diferentes etapas en procesos de muestreo avanzados que requieren control fino (como el muestreo por etapas).
22

3-
## Parámetros de Entrada
3+
## Entradas
44

55
| Parámetro | Tipo de Dato | Tipo de Entrada | Por Defecto | Rango | Descripción Metafórica | Propósito Técnico |
66
| ----------- | ------------- | --------------- | ----------- | --------- | ------------------------ | ------------------- |
@@ -25,18 +25,18 @@ Basado en el código fuente `comfy.samplers.SCHEDULER_NAMES`, soporta los siguie
2525
| **linear_quadratic** | Cuadrático lineal | Optimización de escenarios complejos | Decaimiento de función cuadrática |
2626
| **kl_optimal** | KL óptimo | Optimización teórica | Decaimiento optimizado de divergencia KL |
2727

28-
## Resultados de Salida
28+
## Salidas
2929

3030
| Parámetro | Tipo de Dato | Tipo de Salida | Descripción Metafórica | Significado Técnico |
3131
| --------- | ------------ | -------------- | -------------------------------- | ----------------------------------------------- |
3232
| `sigmas` | SIGMAS | Output | **Tabla de Recetas de Pintura**: Lista detallada de concentración de pintura para uso paso a paso | Secuencia de niveles de ruido, guía el proceso de reducción de ruido del modelo de difusión |
3333

34-
3534
## Rol del Nodo: Asistente de Mezcla de Colores del Artista
3635

3736
Imagina que eres un artista creando una imagen clara a partir de una mezcla caótica de pintura (ruido). `ProgramadorBásico` actúa como tu **asistente profesional de mezcla de colores**, cuyo trabajo es preparar una serie de recetas precisas de concentración de pintura:
3837

3938
### Flujo de Trabajo
39+
4040
- **Paso 1**: Usar pintura de concentración 90% (nivel de ruido alto)
4141
- **Paso 2**: Usar pintura de concentración 80%
4242
- **Paso 3**: Usar pintura de concentración 70%
@@ -46,18 +46,22 @@ Imagina que eres un artista creando una imagen clara a partir de una mezcla caó
4646
### Habilidades Especiales del Asistente de Colores
4747

4848
**Diferentes métodos de mezcla (scheduler)**:
49+
4950
- **Método de mezcla "karras"**: La concentración de pintura cambia muy suavemente, como la técnica de gradiente de un artista profesional
5051
- **Método de mezcla "exponential"**: La concentración de pintura disminuye rápidamente, adecuado para creación rápida
5152
- **Método de mezcla "linear"**: La concentración de pintura disminuye uniformemente, estable y controlable
5253

5354
**Control fino (steps)**:
55+
5456
- **20 mezclas**: Pintura rápida, prioridad en eficiencia
5557
- **50 mezclas**: Pintura fina, prioridad en calidad
5658

5759
**Intensidad de creación (denoise)**:
60+
5861
- **1.0 = Creación completamente nueva**: Comenzar completamente desde lienzo en blanco
5962
- **0.5 = Media transformación**: Mantener la mitad de la pintura original, transformar la mitad
6063
- **0.2 = Ajuste fino**: Solo hacer ajustes sutiles a la pintura original
6164

6265
### Colaboración con Otros Nodos
63-
`ProgramadorBásico` (Asistente de Colores) → Preparar Receta → `ÉchantillonneurPersonnalisé` (Artista) → Pintura Real → Trabajo Completado
66+
67+
`ProgramadorBásico` (Asistente de Colores) → Preparar Receta → `ÉchantillonneurPersonnalisé` (Artista) → Pintura Real → Trabajo Completado

comfyui_embedded_docs/docs/BasicScheduler/fr.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Le nœud `BasicScheduler` est conçu pour calculer une séquence de valeurs sigma pour les modèles de diffusion en fonction du planificateur, du modèle et des paramètres de débruitage fournis. Il ajuste dynamiquement le nombre total d'étapes en fonction du facteur de débruitage pour affiner le processus de diffusion, fournissant des "recettes" précises pour différentes étapes dans les processus d'échantillonnage avancés qui nécessitent un contrôle fin (comme l'échantillonnage par étapes).
22

3-
## Paramètres d'Entrée
3+
## Entrées
44

55
| Paramètre | Type de Données | Type d'Entrée | Par Défaut | Plage | Description Métaphorique | Objectif Technique |
66
| -------------- | --------------- | ------------- | ---------- | --------- | ------------------------ | ------------------ |
@@ -25,18 +25,18 @@ Basé sur le code source `comfy.samplers.SCHEDULER_NAMES`, supporte les 9 planif
2525
| **linear_quadratic** | Quadratique linéaire | Optimisation de scénarios complexes | Décroissance de fonction quadratique |
2626
| **kl_optimal** | KL optimal | Optimisation théorique | Décroissance optimisée de divergence KL |
2727

28-
## Résultats de Sortie
28+
## Sorties
2929

3030
| Paramètre | Type de Données | Type de Sortie | Description Métaphorique | Signification Technique |
3131
| --------- | --------------- | -------------- | ------------------------ | ----------------------- |
3232
| `sigmas` | SIGMAS | Output | **Tableau de Recettes de Peinture**: Liste détaillée de concentration de peinture pour usage étape par étape | Séquence de niveaux de bruit, guide le processus de débruitage du modèle de diffusion |
3333

34-
3534
## Rôle du Nœud: Assistant de Mélange de Couleurs de l'Artiste
3635

3736
Imaginez que vous êtes un artiste créant une image claire à partir d'un mélange chaotique de peinture (bruit). `BasicScheduler` agit comme votre **assistant professionnel de mélange de couleurs**, dont le travail est de préparer une série de recettes précises de concentration de peinture:
3837

3938
### Flux de Travail
39+
4040
- **Étape 1**: Utiliser de la peinture à 90% de concentration (niveau de bruit élevé)
4141
- **Étape 2**: Utiliser de la peinture à 80% de concentration
4242
- **Étape 3**: Utiliser de la peinture à 70% de concentration
@@ -46,18 +46,22 @@ Imaginez que vous êtes un artiste créant une image claire à partir d'un méla
4646
### Compétences Spéciales de l'Assistant Couleurs
4747

4848
**Différentes méthodes de mélange (scheduler)**:
49+
4950
- **Méthode de mélange "karras"**: La concentration de peinture change très doucement, comme la technique de dégradé d'un artiste professionnel
5051
- **Méthode de mélange "exponential"**: La concentration de peinture diminue rapidement, adaptée pour une création rapide
5152
- **Méthode de mélange "linear"**: La concentration de peinture diminue uniformément, stable et contrôlable
5253

5354
**Contrôle fin (steps)**:
55+
5456
- **20 mélanges**: Peinture rapide, priorité à l'efficacité
5557
- **50 mélanges**: Peinture fine, priorité à la qualité
5658

5759
**Intensité de création (denoise)**:
60+
5861
- **1.0 = Création complètement nouvelle**: Commencer complètement à partir d'une toile vierge
5962
- **0.5 = Demi-transformation**: Garder la moitié de la peinture originale, transformer la moitié
6063
- **0.2 = Ajustement fin**: Faire seulement des ajustements subtils à la peinture originale
6164

6265
### Collaboration avec d'Autres Nœuds
63-
`BasicScheduler` (Assistant Couleurs) → Préparer Recette → `SamplerCustom` (Artiste) → Peinture Réelle → Travail Terminé
66+
67+
`BasicScheduler` (Assistant Couleurs) → Préparer Recette → `SamplerCustom` (Artiste) → Peinture Réelle → Travail Terminé

comfyui_embedded_docs/docs/BasicScheduler/ja.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
`基本スケジューラー`ノードは、指定されたスケジューラ、モデル、およびノイズ除去パラメータに基づいて、拡散モデルのためのシグマ値のシーケンスを計算するように設計されています。デノイズファクターに基づいて総ステップ数を動的に調整し、拡散プロセスを微調整し、きめ細かい制御が必要な高度なサンプリングプロセス(段階的サンプリングなど)の異なる段階に対して精密な「レシピ」を提供します。
22

3-
## 入力パラメータ
3+
## 入力
44

55
| パラメータ | データタイプ | 入力タイプ | デフォルト | 範囲 | 比喩的説明 | 技術的目的 |
66
| ------------- | ------------- | --------- | --------- | ------- | ---------------------- | --------------------- |
@@ -25,18 +25,18 @@
2525
| **linear_quadratic** | 線形二次 | 複雑シナリオ最適化 | 二次関数減衰 |
2626
| **kl_optimal** | KL最適 | 理論的最適化 | KLダイバージェンス最適化減衰 |
2727

28-
## 出力結果
28+
## 出力
2929

3030
| パラメータ | データタイプ | 出力タイプ | 比喩的説明 | 技術的意味 |
3131
| --------- | ----------- | --------- | ---------------------------- | ----------------------------- |
3232
| `シグマ` | SIGMAS | Output | **絵の具レシピ表**: 段階的使用のための詳細な絵の具濃度リスト | ノイズレベルシーケンス、拡散モデルのノイズ除去プロセスをガイド |
3333

34-
3534
## ノードの役割: アーティストの調色アシスタント
3635

3736
あなたが混沌とした絵の具(ノイズ)から鮮明な画像を作成するアーティストであることを想像してください。`基本スケジューラー`はあなたの**プロの調色アシスタント**として機能し、その仕事は一連の精密な絵の具濃度レシピを準備することです:
3837

3938
### ワークフロー
39+
4040
- **ステップ1**: 90%濃度の絵の具を使用(高ノイズレベル)
4141
- **ステップ2**: 80%濃度の絵の具を使用
4242
- **ステップ3**: 70%濃度の絵の具を使用
@@ -46,18 +46,22 @@
4646
### カラーアシスタントの特殊スキル
4747

4848
**異なる混合方法 (スケジューラ)**:
49+
4950
- **"karras"混合法**: 絵の具の濃度が非常に滑らかに変化、プロアーティストのグラデーション技法のように
5051
- **"exponential"混合法**: 絵の具の濃度が急速に減少、高速創作に適している
5152
- **"linear"混合法**: 絵の具の濃度が均等に減少、安定で制御可能
5253

5354
**細かい制御 (ステップ)**:
55+
5456
- **20回混合**: 高速描画、効率重視
5557
- **50回混合**: 精密描画、品質重視
5658

5759
**創作強度 (ノイズ除去)**:
60+
5861
- **1.0 = 完全な新規創作**: 完全に白紙のキャンバスから開始
5962
- **0.5 = 半変換**: 元の絵の半分を保持、半分を変換
6063
- **0.2 = 微調整**: 元の絵に微細な調整のみを行う
6164

6265
### 他のノードとの連携
63-
`基本スケジューラー`(カラーアシスタント)→ レシピ準備 → `SamplerCustom`(アーティスト)→ 実際の描画 → 完成作品
66+
67+
`基本スケジューラー`(カラーアシスタント)→ レシピ準備 → `SamplerCustom`(アーティスト)→ 実際の描画 → 完成作品

0 commit comments

Comments
 (0)