After writing the general docstrings, the final step is to add helpful examples to the docstrings. There are eight types of examples, which each need to be added: Functional examples show the function ...
# The example block runs to the next top-level section header (a line starting # in column 0, e.g. "Production Use Cases:") or the end of the docstring. # Terminating on the next header rather than on ...
The @auto_docstring decorator in Transformers generates consistent docstrings for model classes and their methods. It reduces boilerplate by automatically including standard argument descriptions ...