mirror of
https://github.com/huggingface/diffusers.git
synced 2026-01-27 17:22:53 +03:00
f550745a2b
* add; utility to check if attn_procs,norms,acts are properly documented. * add support listing to the workflows. * change to 2024. * small fixes. * does adding detailed docstrings help? * uncomment image processor check * quality * fix, thanks to @mishig. * Apply suggestions from code review Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * style * JointAttnProcessor2_0 * fixes * fixes * fixes * fixes * fixes * fixes * Update docs/source/en/api/normalization.md Co-authored-by: hlky <hlky@hlky.ac> --------- Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> Co-authored-by: hlky <hlky@hlky.ac>
69 lines
2.4 KiB
Python
69 lines
2.4 KiB
Python
import os
|
|
import sys
|
|
import unittest
|
|
from unittest.mock import mock_open, patch
|
|
|
|
|
|
git_repo_path = os.path.abspath(os.path.dirname(os.path.dirname(os.path.dirname(__file__))))
|
|
sys.path.append(os.path.join(git_repo_path, "utils"))
|
|
|
|
from check_support_list import check_documentation # noqa: E402
|
|
|
|
|
|
class TestCheckSupportList(unittest.TestCase):
|
|
def setUp(self):
|
|
# Mock doc and source contents that we can reuse
|
|
self.doc_content = """# Documentation
|
|
## FooProcessor
|
|
|
|
[[autodoc]] module.FooProcessor
|
|
|
|
## BarProcessor
|
|
|
|
[[autodoc]] module.BarProcessor
|
|
"""
|
|
self.source_content = """
|
|
class FooProcessor(nn.Module):
|
|
pass
|
|
|
|
class BarProcessor(nn.Module):
|
|
pass
|
|
"""
|
|
|
|
def test_check_documentation_all_documented(self):
|
|
# In this test, both FooProcessor and BarProcessor are documented
|
|
with patch("builtins.open", mock_open(read_data=self.doc_content)) as doc_file:
|
|
doc_file.side_effect = [
|
|
mock_open(read_data=self.doc_content).return_value,
|
|
mock_open(read_data=self.source_content).return_value,
|
|
]
|
|
|
|
undocumented = check_documentation(
|
|
doc_path="fake_doc.md",
|
|
src_path="fake_source.py",
|
|
doc_regex=r"\[\[autodoc\]\]\s([^\n]+)",
|
|
src_regex=r"class\s+(\w+Processor)\(.*?nn\.Module.*?\):",
|
|
)
|
|
self.assertEqual(len(undocumented), 0, f"Expected no undocumented classes, got {undocumented}")
|
|
|
|
def test_check_documentation_missing_class(self):
|
|
# In this test, only FooProcessor is documented, but BarProcessor is missing from the docs
|
|
doc_content_missing = """# Documentation
|
|
## FooProcessor
|
|
|
|
[[autodoc]] module.FooProcessor
|
|
"""
|
|
with patch("builtins.open", mock_open(read_data=doc_content_missing)) as doc_file:
|
|
doc_file.side_effect = [
|
|
mock_open(read_data=doc_content_missing).return_value,
|
|
mock_open(read_data=self.source_content).return_value,
|
|
]
|
|
|
|
undocumented = check_documentation(
|
|
doc_path="fake_doc.md",
|
|
src_path="fake_source.py",
|
|
doc_regex=r"\[\[autodoc\]\]\s([^\n]+)",
|
|
src_regex=r"class\s+(\w+Processor)\(.*?nn\.Module.*?\):",
|
|
)
|
|
self.assertIn("BarProcessor", undocumented, f"BarProcessor should be undocumented, got {undocumented}")
|