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

Update Op.grad, Op.L_op, and aesara.gradient docstrings and type hints #1038

Conversation

brandonwillard
Copy link
Member

This PR adds a much more informative set of docstrings for Op.grad and Op.L_op. The updated docstrings are clearer about the method inputs and outputs, as well as their underlying mathematical interpretations and relationships.

There is also a bit of refactoring of aesara.gradient;the kind that clarifies function interfaces and helps with typing.

@brandonwillard brandonwillard self-assigned this Jul 5, 2022
@brandonwillard brandonwillard added documentation Improvements or additions to documentation gradient implementations typing Work related to type checking enhancement New feature or request labels Jul 5, 2022
@brandonwillard brandonwillard force-pushed the update-gradient-types-and-docstrings branch 5 times, most recently from a5ef8d4 to 3754669 Compare July 6, 2022 04:30
@brandonwillard brandonwillard force-pushed the update-gradient-types-and-docstrings branch from 3754669 to 62f50bb Compare July 6, 2022 04:39
@codecov
Copy link

codecov bot commented Jul 6, 2022

Codecov Report

Merging #1038 (62f50bb) into main (c8eea20) will increase coverage by 0.00%.
The diff coverage is 91.46%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1038   +/-   ##
=======================================
  Coverage   79.27%   79.27%           
=======================================
  Files         152      152           
  Lines       47976    47965   -11     
  Branches    10921    10923    +2     
=======================================
- Hits        38031    38023    -8     
  Misses       7438     7438           
+ Partials     2507     2504    -3     
Impacted Files Coverage Δ
aesara/graph/op.py 86.59% <ø> (ø)
aesara/gradient.py 77.32% <91.46%> (+0.06%) ⬆️

@brandonwillard brandonwillard merged commit ccfe2d3 into aesara-devs:main Jul 7, 2022
@brandonwillard brandonwillard deleted the update-gradient-types-and-docstrings branch July 7, 2022 00:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request gradient implementations typing Work related to type checking
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants