Module: tfdocs.public_api

Visitor restricting traversal to only the public tensorflow API.

Classes

class FailIfNestedTooDeep

class FilterBaseDirs: A class for filtering based on a list of allowed parent directories.

class FilterPrivateMap

class ProtoMessage: Abstract base class for protocol messages.

Functions

add_proto_fields(...): Add properties to Proto classes, so they can be documented.

explicit_package_contents_filter(...): Filter submodules, only keep what's explicitly included.

filter_builtin_modules(...): Filters module children to remove builtin modules.

filter_doc_controls_skip(...)

filter_module_all(...): Filters module children based on the "all" arrtibute.

filter_private_symbols(...)

get_module_base_dirs(...): Returns the list of base_dirs.

ignore_typing(...): Removes all children that are members of the typing module.

local_definitions_filter(...): Filters children recursively.

Type Aliases

ApiFilter

Children

ALLOWED_DUNDER_METHODS 

{
 '__abs__',
 '__add__',
 '__and__',
 '__array__',
 '__bool__',
 '__call__',
 '__concat__',
 '__contains__',
 '__div__',
 '__enter__',
 '__eq__',
 '__exit__',
 '__floordiv__',
 '__ge__',
 '__getitem__',
 '__gt__',
 '__init__',
 '__invert__',
 '__iter__',
 '__le__',
 '__len__',
 '__lshift__',
 '__lt__',
 '__matmul__',
 '__mod__',
 '__mul__',
 '__ne__',
 '__neg__',
 '__new__',
 '__nonzero__',
 '__or__',
 '__pos__',
 '__pow__',
 '__radd__',
 '__rand__',
 '__rdiv__',
 '__rfloordiv__',
 '__rlshift__',
 '__rmatmul__',
 '__rmod__',
 '__rmul__',
 '__ror__',
 '__rpow__',
 '__rrshift__',
 '__rshift__',
 '__rsub__',
 '__rtruediv__',
 '__rxor__',
 '__sub__',
 '__truediv__',
 '__version__',
 '__xor__'
}

proto None