-
Notifications
You must be signed in to change notification settings - Fork 29
reformat control params and pipeline utils #128
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @sir1st-inc, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request primarily focuses on improving the internal code organization and modularity of the diffsynth_engine. It involves a strategic relocation of the ControlNetParams dataclass to the configs module, aligning it more accurately with its role as a configuration definition. Concurrently, a shared utility function, accumulate, has been extracted into a new pipelines/utils.py file, promoting better separation of concerns and reusability across pipelines. These changes streamline the codebase structure and enhance maintainability.
Highlights
- Refactor: ControlNetParams Relocation: The
ControlNetParamsdataclass has been moved fromdiffsynth_engine/pipelines/controlnet_helper.pytodiffsynth_engine/configs/controlnet.py. This change better categorizesControlNetParamsas a configuration object rather than a pipeline helper, improving module organization. - Refactor: Utility Function Extraction: The
accumulatehelper function, previously located indiffsynth_engine/pipelines/controlnet_helper.py, has been extracted into a new dedicated utility file:diffsynth_engine/pipelines/utils.py. This centralizes common pipeline-related helper functions. - File Removal: The
diffsynth_engine/pipelines/controlnet_helper.pyfile has been removed entirely, as its contents (ControlNetParamsandaccumulate) have been relocated to more appropriate modules. - Import Path Updates: All affected pipeline files (
flux_image.py,sd_image.py,sdxl_image.py) and__init__.pyfiles have been updated to reflect the new import paths forControlNetParamsandaccumulate.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request refactors the project structure by moving ControlNetParams to the configs package and the accumulate function to a new pipelines.utils module. The changes improve code organization. The review includes suggestions to improve code style for long import statements and to add type hints to the new utility function for better clarity and maintainability.
diffsynth_engine/__init__.py
Outdated
| FluxPipelineConfig, | ||
| WanPipelineConfig, | ||
| ) | ||
| from .configs import SDPipelineConfig, SDXLPipelineConfig, FluxPipelineConfig, WanPipelineConfig, ControlNetParams |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For better readability and adherence to PEP 8 style guidelines for long lines, it's recommended to wrap this long import statement using parentheses. This was the style used previously in this file.
| from .configs import SDPipelineConfig, SDXLPipelineConfig, FluxPipelineConfig, WanPipelineConfig, ControlNetParams | |
| from .configs import ( | |
| SDPipelineConfig, | |
| SDXLPipelineConfig, | |
| FluxPipelineConfig, | |
| WanPipelineConfig, | |
| ControlNetParams | |
| ) |
| flux_text_encoder_config, | ||
| ) | ||
| from diffsynth_engine.configs import FluxPipelineConfig, ControlType | ||
| from diffsynth_engine.configs import FluxPipelineConfig, ControlType, ControlNetParams |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To improve readability and adhere to PEP 8 guidelines for line length, it's recommended to wrap this long import statement using parentheses.
| from diffsynth_engine.configs import FluxPipelineConfig, ControlType, ControlNetParams | |
| from diffsynth_engine.configs import ( | |
| FluxPipelineConfig, ControlType, ControlNetParams | |
| ) |
| def accumulate(result, new_item): | ||
| if result is None: | ||
| return new_item | ||
| for i, item in enumerate(new_item): | ||
| result[i] += item | ||
| return result |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To improve code clarity and maintainability, please add type hints to the accumulate function. This will make it easier to understand the expected types for result and new_item and what the function returns. Based on its usage, result is an optional list of tensors, and new_item is a list of tensors.
| def accumulate(result, new_item): | |
| if result is None: | |
| return new_item | |
| for i, item in enumerate(new_item): | |
| result[i] += item | |
| return result | |
| from typing import List, Optional | |
| import torch | |
| def accumulate(result: Optional[List[torch.Tensor]], new_item: List[torch.Tensor]) -> List[torch.Tensor]: | |
| if result is None: | |
| return new_item | |
| for i, item in enumerate(new_item): | |
| result[i] += item | |
| return result |
|
|
||
| from tests.common.test_case import ImageTestCase | ||
| from diffsynth_engine.configs import FluxPipelineConfig | ||
| from diffsynth_engine.configs import FluxPipelineConfig, ControlType, ControlNetParams |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To improve readability and adhere to PEP 8 style for line length, please wrap this long import statement using parentheses.
| from diffsynth_engine.configs import FluxPipelineConfig, ControlType, ControlNetParams | |
| from diffsynth_engine.configs import ( | |
| FluxPipelineConfig, ControlType, ControlNetParams | |
| ) |
No description provided.