Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve creating an op documentation page #1086

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ricardoV94
Copy link
Member

@ricardoV94 ricardoV94 commented Nov 13, 2024

See commit message for list of changes.

The changes are based on feedback from helping other devs and users

Tagging @OriolAbril because I'm 100% sure I messed up some sphinx stuff (sorry)


📚 Documentation preview 📚: https://pytensor--1086.org.readthedocs.build/en/1086/

@ricardoV94 ricardoV94 changed the title Improve creating_an_op.rst Improve creating an op documentation page Nov 13, 2024
@@ -165,35 +151,6 @@ or :meth:`Op.make_thunk`.
:meth:`COp.c_code` and other related ``c_**`` methods. Note that an
:class:`Op` can provide both Python and C implementations.

:meth:`Op.make_thunk` method is another alternative to :meth:`Op.perform`.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is outdated, and tbh I don't think it's necessary for 99.9999% of the people reading this page

Changes:
1. Remove references to c-code which apply to `COp` but not `Op`
2. Fix failing doctests
3. Improve explanation of `make_node`
4. Emphasize distinction between itypes/otypes and make-node
5. Show `L_op` instead of `grad`
6. Show how to test `L_op` and `infer_shape` implementation
7. Simplify explanation of `__props__` and illustrate in example.
8. Introduce more complex multi-output Op to drive these details home
9. Remove old references to numba/ random variable Ops
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant