10000 Add documentation in autodiff modules by ninamiolane · Pull Request #1226 · geomstats/geomstats · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add documentation in autodiff modules #1226

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

Merged
merged 6 commits into from
Dec 15, 2021

Conversation

ninamiolane
Copy link
Collaborator

This closes #1217.

@ninamiolane ninamiolane changed the title Doc autodiff Add documentation in autodiff modules Dec 14, 2021
@ninamiolane ninamiolane requested a review from nguigs December 15, 2021 13:53
Comment on lines -31 to +23
return _elementwise_grad(func)
return x
Copy link
Collaborator

Choose a reason for hiding this comment

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

why this change?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

we do not use it anywhere


Suitable for use in scipy.optimize
Suitable for use in scipy.optimize.
Copy link
Collaborator

Choose a reason for hiding this comment

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

... with numpy=True

Function whose value and gradient values
will be computed.
to_numpy : bool
Unused. Here for API consistency.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is actually used below

Copy link
Collaborator

Choose a reason for hiding this comment

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

I actually added that parameter in the docstring in my ongoing PR #1220

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done.

@ninamiolane ninamiolane merged commit 01b078e into geomstats:master Dec 15, 2021
@ninamiolane ninamiolane deleted the doc-autodiff branch December 15, 2021 17:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docstring to autodiff's modules in backends
2 participants
0