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

[MXNET-340] Updated tutorials page. #10621

Merged
merged 8 commits into from
May 5, 2018
Merged

[MXNET-340] Updated tutorials page. #10621

merged 8 commits into from
May 5, 2018

Conversation

thomelane
Copy link
Contributor

Description

A refactor of the existing tutorial page.

  • Reworded the introduction.
  • Added more structure to the tutorials (nested hierarchy)
  • Moved Straight Dope to Python section.
  • Removed Selector for other languages.
  • Added external link icon.
  • Renamed some tutorials to have more consistent naming.

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

Changes

  • Feature1, tests, (and when applicable, API doc)
  • Feature2, tests, (and when applicable, API doc)

Comments

  • If this change is a backward incompatible change, why must this change be made.
  • Interesting edge cases to note here

@thomelane thomelane requested a review from szha as a code owner April 20, 2018 00:32
piiswrong
piiswrong reviewed Apr 20, 2018
View reviewed changes
docs/tutorials/index.md Outdated
* Core APIs
* NDArray
* [NDArray API](/tutorials/gluon/ndarray.html)
* [NDArray API](http://gluon.mxnet.io/chapter01_crashcourse/ndarray.html) <img src="https://upload.wikimedia.org/wikipedia/commons/6/6a/External_link_font_awesome.svg" alt="External link" height="15px" style="margin: 0px 0px 3px 3px;"/>
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think we should list two versions for each. We should either merge them or pick the better one

@thomelane
Copy link
Contributor Author

JIRA: https://issues.apache.org/jira/browse/MXNET-340

@thomelane thomelane changed the title Updated tutorials page. [MXNET-340] Updated tutorials page. Apr 20, 2018
@thomelane
Copy link
Contributor Author

@piiswrong fixed as suggested, but kept an alternative link in brackets.

@indhub are you able to merge now we have a successful build?

@indhub indhub merged commit 97511ba into apache:master May 5, 2018
anirudh2290 pushed a commit to anirudh2290/mxnet that referenced this pull request May 7, 2018
@thomelane @anirudh2290
[MXNET-340] Updated tutorials page. (apache#10621)
644ed61 
* Updated tutorials page.

* Combined tutorial links

Added "alternative" links.

* Corrected typo

* Force build.

* Force build apache#2

* Force build apache#3

* Force apache#4
jinhuang415 pushed a commit to jinhuang415/incubator-mxnet that referenced this pull request May 29, 2018
@thomelane
[MXNET-340] Updated tutorials page. (apache#10621)
373e92b 
* Updated tutorials page.

* Combined tutorial links

Added "alternative" links.

* Corrected typo

* Force build.

* Force build zheng-da#2

* Force build zheng-da#3

* Force zheng-da#4
rahul003 pushed a commit to rahul003/mxnet that referenced this pull request Jun 4, 2018
@thomelane @indhub
[MXNET-340] Updated tutorials page. (apache#10621)
41a4105 
* Updated tutorials page.

* Combined tutorial links

Added "alternative" links.

* Corrected typo

* Force build.

* Force build #2

* Force build #3

* Force #4
zheng-da pushed a commit to zheng-da/incubator-mxnet that referenced this pull request Jun 28, 2018
@thomelane @zheng-da
[MXNET-340] Updated tutorials page. (apache#10621)
2fce148 
* Updated tutorials page.

* Combined tutorial links

Added "alternative" links.

* Corrected typo

* Force build.

* Force build #2

* Force build #3

* Force #4
@thomelane thomelane deleted the tutorials_page_shuffle branch January 11, 2019 19:46
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@piiswrong piiswrong piiswrong left review comments

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

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@thomelane @piiswrong @indhub