forked from yondonfu/comfystream
-
Notifications
You must be signed in to change notification settings - Fork 6
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Now that the Feature Bank has been merged into the Stream Pack, we should add documentation to explain what it does and how users can integrate it into their workflows.
I've created a quick documentation skeleton for @xilin to review, outlining how we can present this information. I suggest placing it under the Stream Pack tab, within the Custom Nodes section, as a dedicated page titled Feature Bank under the Available Nodes category.
Suggested Page Structure
## Introduction
A brief overview of what the Feature Bank is, with a reference to the related research paper.
## Showcase
A side-by-side comparison with a regular workflow to highlight the improvements made possible by using the Feature Bank.
## Usage
* An image of the workflow showing how the Feature Bank is integrated.
* A clear explanation of how to add it to other workflows.
* A link to example workflow files.
* Descriptions of relevant parameters and how they affect performance.
## Strengths and Limitations
* Scenarios where the node performs well.
* Cases where it may fall short or require adjustments.
## Tips and Best Practices
* Guidance on how to get the most out of the Feature Bank.
* Suggestions based on internal testing or research insights.Deliverables
- A pull request to https://github.com/livepeer/comfstream-docs based on this skeleton draft pull request.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation