Introduce DeprecatedPipelineMixin to simplify pipeline deprecation process #11596
Conversation
This file contains hidden or 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 docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
sayakpaul
approved these changes
May 22, 2025
Comment on lines
+1118
to
+1124
| # Skip tests for pipelines that inherit from DeprecatedPipelineMixin | ||
| from diffusers.pipelines.pipeline_utils import DeprecatedPipelineMixin | ||
|
|
||
| if hasattr(self, "pipeline_class") and issubclass(self.pipeline_class, DeprecatedPipelineMixin): | ||
| import pytest | ||
|
|
||
| pytest.skip(reason=f"Deprecated Pipeline: {self.pipeline_class.__name__}") |
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.
What does this PR do?
Realised that our current deprecation process as seen in this PR: #11354 is quite a big maintenance burden since it isn't trivial to prevent imports from breaking. We have to update a lot of loading code to account for the deprecated pipeline module which is less than ideal.
This PR
_last_supported_versionclass attribute so that it's clear that pipelines may not work as expected past this version.Now no other changes to the codebase should be required when deprecating pipelines. Will close #11354 in favour of this PR.
Fixes # (issue)
Before submitting
documentation guidelines, and
here are tips on formatting docstrings.
Who can review?
Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.