Video XY Plot for ComfyUI
A custom node for ComfyUI that creates XY plots comparing different CFG and Shift values for SD3 models.
Note
This project was created with a cookiecutter template and customized to create a specialized node for parameter comparison.
Quickstart
- Install ComfyUI.
- Install ComfyUI-Manager
- Look up this extension in ComfyUI-Manager. If you are installing manually, clone this repository under
ComfyUI/custom_nodes. - Restart ComfyUI.
Features
- Parameter Comparison: Create grids comparing different CFG and Shift values
- Visual Optimization: Easily find the best parameters for your SD3 models
- Video Support: Process video frames with consistent parameter grids
- Customizable Ranges: Set min, max, and step count for both CFG and Shift values
- Automatic Labeling: Clear labels for each parameter combination
Usage
- Connect a model to the "model" input
- Connect a VAE to the "vae" input
- Connect positive and negative prompts to the respective inputs
- Connect a latent image (can be a video latent with multiple frames)
- Adjust the CFG and Shift ranges as needed
- Run the node to generate the XY plot
For more detailed information, see the developer documentation.
Develop
To install the dev dependencies and pre-commit (will run the ruff hook), do:
cd video_xy_plot
pip install -e .[dev]
pre-commit install
The -e flag above will result in a "live" install, in the sense that any changes you make to your node extension will automatically be picked up the next time you run ComfyUI.
Publish to Github
Install Github Desktop or follow these instructions for ssh.
- Create a Github repository that matches the directory name.
- Push the files to Git
git add .
git commit -m "project scaffolding"
git push
Writing custom nodes
An example custom node is located in node.py. To learn more, read the docs.
Tests
This repo contains unit tests written in Pytest in the tests/ directory. It is recommended to unit test your custom node.
- build-pipeline.yml will run pytest and linter on any open PRs
- validate.yml will run node-diff to check for breaking changes
Publishing to Registry
If you wish to share this custom node with others in the community, you can publish it to the registry. We've already auto-populated some fields in pyproject.toml under tool.comfy, but please double-check that they are correct.
You need to make an account on https://registry.comfy.org and create an API key token.
- Go to the registry. Login and create a publisher id (everything after the
@sign on your registry profile). - Add the publisher id into the pyproject.toml file.
- Create an api key on the Registry for publishing from Github. Instructions.
- Add it to your Github Repository Secrets as
REGISTRY_ACCESS_TOKEN.
A Github action will run on every git push. You can also run the Github action manually. Full instructions here. Join our discord if you have any questions!