[Stable Diffusion] Add components function #889
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The documentation is not available anymore as the PR was closed or merged. |
patrickvonplaten
force-pushed
the
add_components_function
branch
from
c502f1c
to
c1fad36
Compare
patil-suraj
approved these changes
Oct 20, 2022
Comment on lines
+544
to
+578
| @property | ||
| def components(self) -> Dict[str, Any]: | ||
| r""" | ||
|
|
||
| The `self.compenents` property can be useful to run different pipelines with the same weights and | ||
| configurations to not have to re-allocate memory. | ||
|
|
||
| Examples: | ||
|
|
||
| ```py | ||
| >>> from diffusers import ( | ||
| ... StableDiffusionPipeline, | ||
| ... StableDiffusionImg2ImgPipeline, | ||
| ... StableDiffusionInpaintPipeline, | ||
| ... ) | ||
|
|
||
| >>> img2text = StableDiffusionPipeline.from_pretrained("CompVis/stable-diffusion-v1-4") | ||
| >>> img2img = StableDiffusionImg2ImgPipeline(**img2text.components) | ||
| >>> inpaint = StableDiffusionInpaintPipeline(**img2text.components) | ||
| ``` | ||
|
|
||
| Returns: | ||
| A dictionaly containing all the modules needed to initialize the pipleline. | ||
| """ | ||
| components = {k: getattr(self, k) for k in self.config.keys() if not k.startswith("_")} | ||
| expected_modules = set(inspect.signature(self.__init__).parameters.keys()) - set(["self"]) | ||
|
|
||
| if set(components.keys()) != expected_modules: | ||
| raise ValueError( | ||
| f"{self} has been incorrectly initialized or {self.__class__} is incorrectly implemented. Expected" | ||
| f" {expected_modules} to be defined, but {components} are defined." | ||
| ) | ||
|
|
||
| return components | ||
|
|
Comment on lines
+23
to
+37
| - Make use of the [Stable Diffusion Mega Pipeline](https://github.com/huggingface/diffusers/tree/main/examples/community#stable-diffusion-mega) or | ||
| - Make use of the `components` functionality to instantiate all components in the most memory-efficient way: | ||
|
|
||
| ```python | ||
| >>> from diffusers import ( | ||
| ... StableDiffusionPipeline, | ||
| ... StableDiffusionImg2ImgPipeline, | ||
| ... StableDiffusionInpaintPipeline, | ||
| ... ) | ||
|
|
||
| >>> img2text = StableDiffusionPipeline.from_pretrained("CompVis/stable-diffusion-v1-4") | ||
| >>> img2img = StableDiffusionImg2ImgPipeline(**img2text.components) | ||
| >>> inpaint = StableDiffusionInpaintPipeline(**img2text.components) | ||
|
|
||
| >>> # now you can use img2text(...), img2img(...), inpaint(...) just like the call methods of each respective pipeline |
There was a problem hiding this comment.
Nice example! We should also explain a bit more details, for example, the revision, dtype.
Also we should mention that each pipeline needs to be placed on a device so it has it's self.device set.
There was a problem hiding this comment.
Yeah leaving this for a follow-up PR ;-)
prathikr
pushed a commit
to prathikr/diffusers
that referenced
this pull request
Oct 26, 2022
* [Stable Diffusion] Add components function * uP
PhaneeshB
pushed a commit
to nod-ai/diffusers
that referenced
this pull request
Mar 1, 2023
Co-authored-by: dan <dan@nod-labs.com>
yoonseokjin
pushed a commit
to yoonseokjin/diffusers
that referenced
this pull request
Dec 25, 2023
* [Stable Diffusion] Add components function * uP
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.