Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

[DOC] refine autograd docs #15109

Merged
merged 6 commits into from
Aug 1, 2019
Merged

[DOC] refine autograd docs #15109

merged 6 commits into from
Aug 1, 2019

Conversation

larroy
Copy link
Contributor

@larroy larroy commented May 31, 2019

Description

Refines autograd docs, add second order gradient documentation.

@aaronmarkham @apeforest

Checklist

Essentials

Please feel free to remove inapplicable items for your PR.

  • The PR title starts with [MXNET-$JIRA_ID], where $JIRA_ID refers to the relevant JIRA issue created (except PRs with tiny changes)
  • Changes are complete (i.e. I finished coding on this PR)
  • All changes have test coverage:
  • Unit tests are added for small changes to verify correctness (e.g. adding a new operator)
  • Nightly tests are added for complicated/long-running ones (e.g. changing distributed kvstore)
  • Build tests will be added for build configuration changes (e.g. adding a new build option with NCCL)
  • Code is well-documented:
  • For user-facing API changes, API doc string has been updated.
  • For new C++ functions in header files, their functionalities and arguments are documented.
  • For new examples, README.md is added to explain the what the example does, the source of the dataset, expected performance on test set and reference to the original paper if applicable
  • Check the API doc at http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-$PR_ID/$BUILD_ID/index.html
  • To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change

@larroy larroy requested a review from szha as a code owner May 31, 2019 03:25
aaronmarkham
aaronmarkham approved these changes May 31, 2019
View reviewed changes
Copy link
Contributor

@aaronmarkham aaronmarkham left a comment

Choose a reason for hiding this comment

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

Just a style comment in there...

docs/api/python/autograd/autograd.md Outdated Show resolved Hide resolved
@abhinavs95
Copy link
Contributor

@mxnet-label-bot add [Doc]

@marcoabreu marcoabreu added the Doc label May 31, 2019
@larroy larroy force-pushed the autograd_doc branch 2 times, most recently from 1b86fc1 to fd9635d Compare June 5, 2019 18:29
@larroy
Copy link
Contributor Author

larroy commented Jun 5, 2019

@kshitij12345

@larroy
Copy link
Contributor Author

larroy commented Jun 5, 2019

#15120

@larroy
Copy link
Contributor Author

larroy commented Jun 5, 2019

#14613

@larroy
Copy link
Contributor Author

larroy commented Jun 5, 2019

@mxnet-label-bot add [pr-awaiting-merge]

@marcoabreu marcoabreu added the pr-awaiting-merge Review and CI is complete. Ready to Merge label Jun 5, 2019
anirudhacharya
anirudhacharya reviewed Jun 6, 2019
View reviewed changes
docs/api/python/autograd/autograd.md Outdated Show resolved Hide resolved
docs/api/python/autograd/autograd.md Outdated Show resolved Hide resolved
docs/api/python/autograd/autograd.md Outdated Show resolved Hide resolved
@larroy
Copy link
Contributor Author

larroy commented Jun 13, 2019

@szha @apeforest can we merge this PR?

@apeforest
Copy link
Contributor

Can you address @kshitij12345 's question?

@apeforest
Copy link
Contributor

Thanks for the contribution. I added some comments regarding the example.

@larroy
Copy link
Contributor Author

larroy commented Jun 15, 2019

Fixes:
#14991

@larroy
Copy link
Contributor Author

larroy commented Jun 28, 2019

@apeforest @kshitij12345 can this go?

@karan6181
Copy link
Contributor

@larroy Gentle ping!

kshitij12345
kshitij12345 approved these changes Jul 26, 2019
View reviewed changes
Copy link
Contributor

@kshitij12345 kshitij12345 left a comment

Choose a reason for hiding this comment

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

LGTM.

apeforest
apeforest approved these changes Aug 1, 2019
View reviewed changes
Copy link
Contributor

@apeforest apeforest left a comment

Choose a reason for hiding this comment

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

LGTM

@apeforest apeforest merged commit d5fcd98 into apache:master Aug 1, 2019
anirudhacharya pushed a commit to anirudhacharya/mxnet that referenced this pull request Aug 20, 2019
@larroy
[DOC] refine autograd docs (apache#15109)
b29cb40 
* refine autograd docs

* CR comments

* Fix examples

* CR comments

* Followup CR

* CR
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@anirudhacharya anirudhacharya anirudhacharya left review comments

@aaronmarkham aaronmarkham aaronmarkham approved these changes

@apeforest apeforest apeforest approved these changes

@kshitij12345 kshitij12345 kshitij12345 approved these changes

@szha szha Awaiting requested review from szha szha is a code owner

Assignees
No one assigned
Labels
Doc pr-awaiting-merge Review and CI is complete. Ready to Merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@larroy @abhinavs95 @apeforest @karan6181 @anirudhacharya @aaronmarkham @kshitij12345 @marcoabreu