[WIP] chore: add utilities to check if call/forward methods are documented. (#13758)

* chore: add utilities to check if call/forward methods are documented.

* Fix missing forward/__call__ docstring entries (#13769)

add missing

* style.

---------

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Co-authored-by: YiYi Xu <yixu310@gmail.com>

Author: 3 people

.github/workflows/pr_modular_tests.yml

@@ -73,6 +73,7 @@ jobs:
           python utils/check_copies.py
           python utils/check_dummies.py
           python utils/check_support_list.py
+          python utils/check_forward_call_docstrings.py
           make deps_table_check_updated
       - name: Check if failure
         if: ${{ failure() }}

.github/workflows/pr_tests.yml

@@ -68,6 +68,7 @@ jobs:
           python utils/check_copies.py
           python utils/check_dummies.py
           python utils/check_support_list.py
+          python utils/check_forward_call_docstrings.py
           make deps_table_check_updated
       - name: Check if failure
         if: ${{ failure() }}

.github/workflows/pr_tests_gpu.yml

@@ -69,6 +69,7 @@ jobs:
           python utils/check_copies.py
           python utils/check_dummies.py
           python utils/check_support_list.py
+          python utils/check_forward_call_docstrings.py
           make deps_table_check_updated
       - name: Check if failure
         if: ${{ failure() }}

Makefile

@@ -36,6 +36,7 @@ repo-consistency:
 	python utils/check_dummies.py
 	python utils/check_repo.py
 	python utils/check_inits.py
+	python utils/check_forward_call_docstrings.py
 
 # this target runs checks on all files
 
@@ -74,6 +75,10 @@ fix-copies:
 modular-autodoctrings:
 	python utils/modular_auto_docstring.py
 
+# Verify forward() / __call__() arguments are documented in their docstrings
+check-forward-call-docstrings:
+	python utils/check_forward_call_docstrings.py
+
 # Run tests for the library
 
 test:

src/diffusers/models/adapter.py

@@ -269,6 +269,10 @@ def forward(self, x: torch.Tensor) -> list[torch.Tensor]:
         each representing information extracted at a different scale from the input. The length of the list is
         determined by the number of downsample blocks in the Adapter, as specified by the `channels` and
         `num_res_blocks` parameters during initialization.
+
+        Args:
+            x (`torch.Tensor`):
+                The input tensor to process through the adapter model.
         """
         return self.adapter(x)
 

src/diffusers/models/autoencoders/autoencoder_asym_kl.py

@@ -166,6 +166,9 @@ def forward(
                 Whether to sample from the posterior.
             return_dict (`bool`, *optional*, defaults to `True`):
                 Whether or not to return a [`DecoderOutput`] instead of a plain tuple.
+            generator (`torch.Generator`, *optional*):
+                A [`torch.Generator`](https://pytorch.org/docs/stable/generated/torch.Generator.html) to make sampling
+                deterministic.
         """
         x = sample
         posterior = self.encode(x).latent_dist

src/diffusers/models/autoencoders/autoencoder_dc.py

@@ -706,6 +706,12 @@ def tiled_decode(self, z: torch.Tensor, return_dict: bool = True) -> DecoderOutp
         return DecoderOutput(sample=decoded)
 
     def forward(self, sample: torch.Tensor, return_dict: bool = True) -> torch.Tensor:
+        r"""
+        Args:
+            sample (`torch.Tensor`): Input sample.
+            return_dict (`bool`, *optional*, defaults to `True`):
+                Whether or not to return a [`DecoderOutput`] instead of a plain tuple.
+        """
         encoded = self.encode(sample, return_dict=False)[0]
         decoded = self.decode(encoded, return_dict=False)[0]
         if not return_dict:

src/diffusers/models/autoencoders/autoencoder_kl.py

@@ -424,6 +424,9 @@ def forward(
                 Whether to sample from the posterior.
             return_dict (`bool`, *optional*, defaults to `True`):
                 Whether or not to return a [`DecoderOutput`] instead of a plain tuple.
+            generator (`torch.Generator`, *optional*):
+                A [`torch.Generator`](https://pytorch.org/docs/stable/generated/torch.Generator.html) to make sampling
+                deterministic.
         """
         x = sample
         posterior = self.encode(x).latent_dist

src/diffusers/models/autoencoders/autoencoder_kl_cogvideox.py

@@ -1409,6 +1409,17 @@ def forward(
         return_dict: bool = True,
         generator: torch.Generator | None = None,
     ) -> torch.Tensor | torch.Tensor:
+        r"""
+        Args:
+            sample (`torch.Tensor`): Input sample.
+            sample_posterior (`bool`, *optional*, defaults to `False`):
+                Whether to sample from the posterior.
+            return_dict (`bool`, *optional*, defaults to `True`):
+                Whether or not to return a [`DecoderOutput`] instead of a plain tuple.
+            generator (`torch.Generator`, *optional*):
+                A [`torch.Generator`](https://pytorch.org/docs/stable/generated/torch.Generator.html) to make sampling
+                deterministic.
+        """
         x = sample
         posterior = self.encode(x).latent_dist
         if sample_posterior:

src/diffusers/models/autoencoders/autoencoder_kl_cosmos.py

@@ -1078,6 +1078,17 @@ def forward(
         return_dict: bool = True,
         generator: torch.Generator | None = None,
     ) -> tuple[torch.Tensor] | DecoderOutput:
+        r"""
+        Args:
+            sample (`torch.Tensor`): Input sample.
+            sample_posterior (`bool`, *optional*, defaults to `False`):
+                Whether to sample from the posterior.
+            return_dict (`bool`, *optional*, defaults to `True`):
+                Whether or not to return a [`DecoderOutput`] instead of a plain tuple.
+            generator (`torch.Generator`, *optional*):
+                A [`torch.Generator`](https://pytorch.org/docs/stable/generated/torch.Generator.html) to make sampling
+                deterministic.
+        """
         x = sample
         posterior = self.encode(x).latent_dist
         if sample_posterior: