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

DOC: wrong indentation level in gradient.py grad Lop and Rop #414

Closed
hsinfan1996 opened this issue Aug 16, 2023 · 2 comments · Fixed by #415
Closed

DOC: wrong indentation level in gradient.py grad Lop and Rop #414

hsinfan1996 opened this issue Aug 16, 2023 · 2 comments · Fixed by #415
Labels

Comments

@hsinfan1996
Copy link
Contributor

hsinfan1996 commented Aug 16, 2023

Issue with current documentation:

pytensor.gradient.grad

Returns
-------
A symbolic expression for the gradient of `cost` with respect to each
of the `wrt` terms. If an element of `wrt` is not differentiable with
respect to the output, then a zero variable is returned.
"""

pytensor.gradient.Lop
Returns
-------
A symbolic expression satisfying
``L_op[i] = sum_i (d f[i] / d wrt[j]) eval_point[i]``
where the indices in that expression are magic multidimensional
indices that specify both the position within a list and all
coordinates of the tensor elements.
If `f` is a list/tuple, then return a list/tuple with the results.

pytensor.gradient.Rop
Returns
-------
A symbolic expression such obeying
``R_op[i] = sum_j (d f[i] / d wrt[j]) eval_point[j]``,
where the indices in that expression are magic multidimensional
indices that specify both the position within a list and all
coordinates of the tensor elements.
If `wrt` is a list/tuple, then return a list/tuple with the results.

Idea or request for content:

Make it one indentation level less for the content of Returns and remove the extra blank line at the end (only for grad).

@hsinfan1996 hsinfan1996 changed the title DOC: wrong indentation level in gradient.py grad DOC: wrong indentation level in gradient.py grad Lop Aug 16, 2023
@hsinfan1996 hsinfan1996 changed the title DOC: wrong indentation level in gradient.py grad Lop DOC: wrong indentation level in gradient.py grad Lop and Rop Aug 16, 2023
@ricardoV94
Copy link
Member

Thanks, would you like to fix it yourself?

@hsinfan1996
Copy link
Contributor Author

Thanks, would you like to fix it yourself?

Yes.

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 a pull request may close this issue.

2 participants