deprecate dduf.

Author: sayakpaul

docs/source/en/using-diffusers/other-formats.md

@@ -220,6 +220,9 @@ pipeline = DiffusionPipeline.from_single_file(
 
 ### dduf
 
+> [!WARNING]
+> DDUF support is deprecated and will be removed in version 0.41.0. Save and load your pipelines using the standard Diffusers directory format instead.
+
 > [!TIP]
 > DDUF is an experimental file type and the API may change. Refer to the DDUF [docs](https://huggingface.co/docs/hub/dduf) to learn more.
 

src/diffusers/pipelines/pipeline_utils.py

@@ -58,6 +58,7 @@
     PushToHubMixin,
     _get_detailed_type,
     _is_valid_type,
+    deprecate,
     is_accelerate_available,
     is_accelerate_version,
     is_bitsandbytes_version,
@@ -114,6 +115,11 @@
 
 SUPPORTED_DEVICE_MAP = ["balanced"] + [get_device(), "cpu"]
 
+_DDUF_DEPRECATION_MESSAGE = (
+    "Loading pipelines from DDUF files is deprecated and DDUF support will be removed entirely. "
+    "Please save and load your pipelines using the standard Diffusers directory format instead."
+)
+
 logger = logging.get_logger(__name__)
 
 
@@ -730,7 +736,8 @@ def from_pretrained(cls, pretrained_model_name_or_path: str | os.PathLike, **kwa
                 Load weights from a specified variant filename such as `"fp16"` or `"ema"`. This is ignored when
                 loading `from_flax`.
             dduf_file(`str`, *optional*):
-                Load weights from the specified dduf file.
+                Load weights from the specified dduf file. <Deprecated> This argument is deprecated and will be removed
+                in version 0.41.0. </Deprecated>
             disable_mmap ('bool', *optional*, defaults to 'False'):
                 Whether to disable mmap when loading a Safetensors model. This option can perform better when the model
                 is on a network mount or hard drive, which may not handle the seeky-ness of mmap very well.
@@ -843,6 +850,7 @@ def from_pretrained(cls, pretrained_model_name_or_path: str | os.PathLike, **kwa
             )
 
         if dduf_file:
+            deprecate("dduf_file", "0.41.0", _DDUF_DEPRECATION_MESSAGE)
             if custom_pipeline:
                 raise NotImplementedError("Custom pipelines are not supported with DDUF at the moment.")
             if load_connected_pipeline:
@@ -1572,7 +1580,8 @@ def download(cls, pretrained_model_name, **kwargs) -> str | os.PathLike:
                 Load weights from a specified variant filename such as `"fp16"` or `"ema"`. This is ignored when
                 loading `from_flax`.
             dduf_file(`str`, *optional*):
-                Load weights from the specified DDUF file.
+                Load weights from the specified DDUF file. <Deprecated> This argument is deprecated and will be removed
+                in version 0.41.0. </Deprecated>
             use_safetensors (`bool`, *optional*, defaults to `None`):
                 If set to `None`, the safetensors weights are downloaded if they're available **and** if the
                 safetensors library is installed. If set to `True`, the model is forcibly loaded from safetensors
@@ -1616,6 +1625,7 @@ def download(cls, pretrained_model_name, **kwargs) -> str | os.PathLike:
         use_flashpack = kwargs.pop("use_flashpack", False)
 
         if dduf_file:
+            deprecate("dduf_file", "0.41.0", _DDUF_DEPRECATION_MESSAGE)
             if custom_pipeline:
                 raise NotImplementedError("Custom pipelines are not supported with DDUF at the moment.")
             if load_connected_pipeline:

tests/pipelines/test_pipelines.py

@@ -2014,6 +2014,16 @@ def test_dduf_raises_error_with_connected_pipeline(self):
                 "DDUF/tiny-flux-dev-pipe-dduf", dduf_file="fluxpipeline.dduf", load_connected_pipeline=True
             )
 
+    @require_hf_hub_version_greater("0.26.5")
+    @require_transformers_version_greater("4.47.1")
+    def test_dduf_file_is_deprecated(self):
+        with tempfile.TemporaryDirectory() as tmpdir:
+            with self.assertWarns(FutureWarning) as warning_ctx:
+                _ = DiffusionPipeline.from_pretrained(
+                    "DDUF/tiny-flux-dev-pipe-dduf", dduf_file="fluxpipeline.dduf", cache_dir=tmpdir
+                )
+        assert "dduf_file" in str(warning_ctx.warning)
+
     @pytest.mark.xfail(condition=is_transformers_version(">", "4.56.2"), reason="Some import error", strict=False)
     def test_wrong_model(self):
         tokenizer = CLIPTokenizer.from_pretrained("hf-internal-testing/tiny-random-clip")