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

[MXNET-949] Module API to Gluon API tutorial #12542

Merged
merged 12 commits into from
Mar 21, 2019

Conversation

ThomasDelteil
Copy link
Contributor

@ThomasDelteil ThomasDelteil commented Sep 13, 2018

Description

Adding a tutorial to show the correspondence between Module and Gluon API to help users transition from the Module API to the Gluon one.

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:
  • Nightly tests are added for complicated/long-running ones (e.g. changing distributed kvstore)
  • Code is well-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
  • To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change

@ThomasDelteil ThomasDelteil changed the title [WIP][MXNET-949] Module API to Gluon API tutorial [MXNET-949] Module API to Gluon API tutorial Sep 13, 2018
docs/tutorials/python/module_to_gluon.md Outdated Show resolved Hide resolved
docs/tutorials/python/module_to_gluon.md Outdated Show resolved Hide resolved
docs/tutorials/python/module_to_gluon.md Outdated Show resolved Hide resolved
docs/tutorials/python/module_to_gluon.md Outdated Show resolved Hide resolved
docs/tutorials/python/module_to_gluon.md Outdated Show resolved Hide resolved
@kalyc
Copy link
Contributor

kalyc commented Sep 14, 2018

Thanks for your contribution @ThomasDelteil
@mxnet-label-bot[pr-awaiting-response]

@marcoabreu marcoabreu added the pr-awaiting-response PR is reviewed and waiting for contributor to respond label Sep 14, 2018
@sandeep-krishnamurthy
Copy link
Contributor

@ThomasDelteil - Can you please rebase and resolve conflict?

@vandanavk
Copy link
Contributor

@aaronmarkham for review

@sandeep-krishnamurthy Please change the label to pr-awaiting-testing

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.

I enjoyed this tutorial. This comparison was really needed. There are some minor grammatical/spelling issues and some clarity needs. I feel like each section should have a standard flow:

  1. overall intro of what the section does and very high level of how module/gluon differ
  2. code examples with intro
  3. compare / contrast detail + links to more examples

docs/tutorials/index.md Outdated Show resolved Hide resolved
docs/tutorials/python/module_to_gluon.md Outdated Show resolved Hide resolved
docs/tutorials/python/module_to_gluon.md Show resolved Hide resolved
docs/tutorials/python/module_to_gluon.md Show resolved Hide resolved
docs/tutorials/python/module_to_gluon.md Outdated Show resolved Hide resolved
docs/tutorials/python/module_to_gluon.md Outdated Show resolved Hide resolved
docs/tutorials/python/module_to_gluon.md Show resolved Hide resolved
docs/tutorials/python/module_to_gluon.md Show resolved Hide resolved
docs/tutorials/python/module_to_gluon.md Outdated Show resolved Hide resolved
docs/tutorials/python/module_to_gluon.md Show resolved Hide resolved
@Roshrini
Copy link
Member

@ThomasDelteil Can you please address review comments and resolve conflicting files?
@sandeep-krishnamurthy Can you please change PR label to "pr-awaiting-response"?

@roywei
Copy link
Member

roywei commented Oct 29, 2018

ping @ThomasDelteil , any update on this PR?

@ThomasDelteil
Copy link
Contributor Author

@roywei going to go through the comments this afternoon and push an update

Copy link
Member

@anirudhacharya anirudhacharya left a comment

Choose a reason for hiding this comment

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

should we add a note on how to visualize networks in - symbol graphs vs gluon blocks?

docs/tutorials/python/module_to_gluon.md Show resolved Hide resolved
docs/tutorials/python/module_to_gluon.md Outdated Show resolved Hide resolved
docs/tutorials/python/module_to_gluon.md Outdated Show resolved Hide resolved
docs/tutorials/python/module_to_gluon.md Outdated Show resolved Hide resolved
@lupesko
Copy link
Contributor

lupesko commented Nov 20, 2018

@ThomasDelteil thanks for the contribution - can you please follow up on the comments?

@ThomasDelteil
Copy link
Contributor Author

will re-open once I have time to address the comments, thanks all for the reviews 👍

@ThomasDelteil ThomasDelteil reopened this Mar 15, 2019
@ThomasDelteil ThomasDelteil added pr-awaiting-review PR is waiting for code review and removed pr-awaiting-response PR is reviewed and waiting for contributor to respond labels Mar 19, 2019
Copy link
Contributor

@thomelane thomelane left a comment

Choose a reason for hiding this comment

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

Much needed tutorial! Great job @ThomasDelteil. Only very minor suggestions.

docs/tutorials/python/module_to_gluon.md Outdated Show resolved Hide resolved
docs/tutorials/python/module_to_gluon.md Outdated Show resolved Hide resolved
docs/tutorials/python/module_to_gluon.md Outdated Show resolved Hide resolved
docs/tutorials/python/module_to_gluon.md Outdated Show resolved Hide resolved
@ThomasDelteil ThomasDelteil merged commit a88c562 into apache:master Mar 21, 2019
vdantu pushed a commit to vdantu/incubator-mxnet that referenced this pull request Mar 31, 2019
* Adding tutorial module to gluon

* update test

* update wording and typos

* Update index.md

* trigger build

* update after review

* update after review

* update after review

* adding license

* Update module_to_gluon.md

* trigger
ZhennanQin pushed a commit to ZhennanQin/incubator-mxnet that referenced this pull request Apr 3, 2019
* Adding tutorial module to gluon

* update test

* update wording and typos

* Update index.md

* trigger build

* update after review

* update after review

* update after review

* adding license

* Update module_to_gluon.md

* trigger
nswamy pushed a commit that referenced this pull request Apr 5, 2019
* Adding tutorial module to gluon

* update test

* update wording and typos

* Update index.md

* trigger build

* update after review

* update after review

* update after review

* adding license

* Update module_to_gluon.md

* trigger
haohuanw pushed a commit to haohuanw/incubator-mxnet that referenced this pull request Jun 23, 2019
* Adding tutorial module to gluon

* update test

* update wording and typos

* Update index.md

* trigger build

* update after review

* update after review

* update after review

* adding license

* Update module_to_gluon.md

* trigger
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
pr-awaiting-review PR is waiting for code review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet