frozenleaves/pytorch
1
0
Fork 0
mirror of https://github.com/pytorch/pytorch.git synced 2025-10-20 21:14:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated Public API definition and documentation (markdown)

albanD
2022-04-13 11:15:57 -04:00
parent 0f6a2885eb
commit f2b0a29486
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Public-API-definition-and-documentation.md

@ -8,8 +8,8 @@ Other objects, in particular functions and classes, are public if they have a `_
To ensure that we can check that all objects that "looks public" are expected, we also have the following constraints for public submodules within the torch namespace. They should either: To ensure that we can check that all objects that "looks public" are expected, we also have the following constraints for public submodules within the torch namespace. They should either:
- Define `__all__` - Define `__all__`
- In this case, all callable and classes in `__all__` must have their `__module__` start with the current submodule’s path. - In this case, all callable and classes in `__all__` must have their `__module__` start with the current submodule.
- All attributes that are not in `__all__` must NOT have their `__module__` start with the current submodule's path. - All attributes that are not in `__all__` must NOT have their `__module__` start with the current submodule.
- Not define `__all__` - Not define `__all__`
- In this case, all the objects in `dir(submod)` must have their `__module__` that start with the current submodule. - In this case, all the objects in `dir(submod)` must have their `__module__` that start with the current submodule.