tfdocs.doc_generator_visitor.PathTreeNode

Represents a path to an object in the API, an object can have many paths.

tfdocs.doc_generator_visitor.PathTreeNode(
    path: ApiPath,
    py_object: Any,
    parent: Optional[PathTreeNode] = None,
    children: Dict[str, PathTreeNode] = dataclasses.field(default_factory=dict)
)

path A tuple of strings containing the path to the object from the root like ('tf', 'losses', 'hinge')
py_object The python object.
children A dictionary from short name to PathTreeNode, of this node's children.
parent This node's parent. This is a tree, there can only be one.
short_name The last path component
full_name All path components joined with "."

Methods

__eq__

View source

__eq__(
    other
)

Return self==value.

parent None