get_functions function
keras_autodoc.get_functions(module, exclude: List[str] = None, return_strings: bool = True)
Get all the functions of a module.
Arguments
- module: The module to fetch the functions from. If it's a
string, it should be in the dotted format.
'keras.backend'for example. - exclude: The names which will be excluded from the returned list. For
example,
get_functions('keras.backend', exclude=['max']). - return_strings: If False, the actual functions will be returned. Note that
if you use aliases when building your docs, you should use strings.
This is because the computed signature uses
__name__and__module__if you don't provide a string as input.
Returns
A list of strings or a list of functions.
get_classes function
keras_autodoc.get_classes(module, exclude: List[str] = None, return_strings: bool = True)
Get all the classes of a module.
Arguments
- module: The module to fetch the classes from. If it's a
string, it should be in the dotted format.
'keras.layers'for example. - exclude: The names which will be excluded from the returned list. For
example,
get_classes('keras.layers', exclude=['Dense', 'Conv2D']). - return_strings: If False, the actual classes will be returned. Note that
if you use aliases when building your docs, you should use strings.
This is because the computed signature uses
__name__and__module__if you don't provide a string as input.
Returns
A list of strings or a list of classes.
get_methods function
keras_autodoc.get_methods(cls, exclude=None, return_strings=True)
Get all the method of a class.
Arguments
- cls: The class to fetch the methods from. If it's a
string, it should be in the dotted format.
'keras.layers.Dense'for example. - exclude: The names which will be excluded from the returned list. For
example,
get_methods('keras.Model', exclude=['save']). - return_strings: If False, the actual methods will be returned. Note that
if you use aliases when building your docs, you should use strings.
This is because the computed signature uses
__name__and__module__if you don't provide a string as input.
Returns
A list of strings or a list of methods.