Description
There are several undocumented or partially documented aspects of the tensor classes, derivatives, broadcasting logic, etc. We should write thorough docstrings and possibly a user guide.
What Needs Documentation?
- Explanation of key classes (
Tensor, Variable, Function, Derivative, etc.) and their intended usage.
- The roles and interactions of the different components (e.g. how
Product uses Copy tensors internally).
- Usage examples, from constructing symbolic expressions to evaluating them with PyTorch.
- Explanation of advanced features, like the isomorphism hashing.
Benefits
- Better onboarding for new contributors.
- Easier debugging and maintenance.
Additional Resources
- Potentially set up a read-the-docs site or GitHub Pages for the project.
Description
There are several undocumented or partially documented aspects of the tensor classes, derivatives, broadcasting logic, etc. We should write thorough docstrings and possibly a user guide.
What Needs Documentation?
Tensor,Variable,Function,Derivative, etc.) and their intended usage.ProductusesCopytensors internally).Benefits
Additional Resources