Skip to content

Commit dd3ea5a

Browse files
make changes to docstring generation
1 parent 7975475 commit dd3ea5a

File tree

2 files changed

+24
-18
lines changed

2 files changed

+24
-18
lines changed

scripts/docstrings.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -217,10 +217,16 @@ def __repr__(self):
217217
# Render the function name instead
218218
return ReprWrapper(value.__name__)
219219

220+
if inspect.isclass(value):
221+
# Render classes as module.ClassName to produce a valid python
222+
# dotted-name expression in the fake signature (black can parse it).
223+
return ReprWrapper(value.__module__ + "." + value.__name__)
224+
220225
if (
221226
repr(value).startswith("<") # <Foo object at 0x00000000>
222227
and hasattr(value, "__class__") # it is an object
223228
and hasattr(value, "get_config") # it is a Keras object
229+
and not inspect.isclass(value) # ensure it's an instance, not a class
224230
):
225231
config = value.get_config()
226232
init_args = [] # The __init__ arguments to render

scripts/hub_master.py

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1805,43 +1805,43 @@
18051805
},
18061806
{
18071807
"path": "parseq/",
1808-
"title": "ParSeq",
1808+
"title": "PARSeq",
18091809
"toc": True,
18101810
"children": [
18111811
{
18121812
"path": "parseq_tokenizer",
1813-
"title": "ParSeqTokenizer",
1813+
"title": "PARSeqTokenizer",
18141814
"generate": [
1815-
"keras_hub.tokenizers.ParSeqTokenizer",
1816-
"keras_hub.tokenizers.ParSeqTokenizer.from_preset",
1815+
"keras_hub.tokenizers.PARSeqTokenizer",
1816+
"keras_hub.tokenizers.PARSeqTokenizer.from_preset",
18171817
],
18181818
},
18191819
{
18201820
"path": "parseq_backbone",
1821-
"title": "ParSeqBackbone model",
1821+
"title": "PARSeqBackbone model",
18221822
"generate": [
1823-
"keras_hub.models.ParSeqBackbone",
1824-
"keras_hub.models.ParSeqBackbone.from_preset",
1823+
"keras_hub.models.PARSeqBackbone",
1824+
"keras_hub.models.PARSeqBackbone.from_preset",
18251825
],
18261826
},
18271827
{
18281828
"path": "parseq_causal_lm",
1829-
"title": "ParSeqCausalLM model",
1829+
"title": "PARSeqCausalLM model",
18301830
"generate": [
1831-
"keras_hub.models.ParSeqCausalLM",
1832-
"keras_hub.models.ParSeqCausalLM.from_preset",
1833-
"keras_hub.models.ParSeqCausalLM.generate",
1834-
"keras_hub.models.ParSeqCausalLM.backbone",
1835-
"keras_hub.models.ParSeqCausalLM.preprocessor",
1831+
"keras_hub.models.PARSeqCausalLM",
1832+
"keras_hub.models.PARSeqCausalLM.from_preset",
1833+
"keras_hub.models.PARSeqCausalLM.generate",
1834+
"keras_hub.models.PARSeqCausalLM.backbone",
1835+
"keras_hub.models.PARSeqCausalLM.preprocessor",
18361836
],
18371837
},
18381838
{
1839-
"path": "parseq_preprocessor",
1840-
"title": "ParSeqPreprocessor layer",
1839+
"path": "parseq_causal_lmpreprocessor",
1840+
"title": "PARSeqCausalLMPreprocessor layer",
18411841
"generate": [
1842-
"keras_hub.models.ParSeqPreprocessor",
1843-
"keras_hub.models.ParSeqPreprocessor.from_preset",
1844-
"keras_hub.models.ParSeqPreprocessor.tokenizer",
1842+
"keras_hub.models.PARSeqCausalLMPreprocessor",
1843+
"keras_hub.models.PARSeqCausalLMPreprocessor.from_preset",
1844+
"keras_hub.models.PARSeqCausalLMPreprocessor.tokenizer",
18451845
],
18461846
},
18471847
],

0 commit comments

Comments
 (0)