[website] Refactor on existing Tutorials part structure

[chenw23]

Description

According to issue (#1081), the main structure of the website examples part needs to be refactored. Currently this pull request deals with part of this issue. This pull request refactors all the existing files in the examples part of the website. All existing structure of the examples part of the website are modified accordingly. For new features about adding new files to the examples part of the website, they will be handled in future pull requests.

Checklist

Essentials

• [x] PR's title starts with a category (e.g. [BUGFIX], [MODEL], [TUTORIAL], [FEATURE], [DOC], etc)
• [x] Changes are complete (i.e. I finished coding on this PR)
• [x] All changes have test coverage
• [x] Code is well-documented

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

cc @dmlc/gluon-nlp-team

[codecov[bot]]

Codecov Report

Merging #1154 into master will decrease coverage by 5.63%. The diff coverage is 84.06%.

@@            Coverage Diff             @@
##           master    #1154      +/-   ##
==========================================
- Coverage   82.82%   77.18%   -5.64%     
==========================================
  Files          72       72              
  Lines        6970     6970              
==========================================
- Hits         5773     5380     -393     
- Misses       1197     1590     +393

Impacted Files	Coverage Δ
src/gluonnlp/optimizer/__init__.py	100% <100%> (ø)	:arrow_up:
src/gluonnlp/data/sampler.py	96.81% <100%> (ø)	:arrow_up:
src/gluonnlp/data/question_answering.py	100% <100%> (ø)	:arrow_up:
src/gluonnlp/model/sampled_block.py	90.74% <100%> (ø)	:arrow_up:
src/gluonnlp/calibration/__init__.py	100% <100%> (+100%)	:arrow_up:
src/gluonnlp/utils/version.py	100% <100%> (ø)	:arrow_up:
src/gluonnlp/utils/parameter.py	87.09% <100%> (ø)	:arrow_up:
src/gluonnlp/metric/__init__.py	100% <100%> (ø)	:arrow_up:
src/gluonnlp/metric/masked_accuracy.py	100% <100%> (ø)	:arrow_up:
src/gluonnlp/data/transforms.py	83.05% <100%> (+1.66%)	:arrow_up:
... and 48 more

[mli]

Job PR-1154/6 is complete. Docs are uploaded to http://gluon-nlp-staging.s3-accelerate.dualstack.amazonaws.com/PR-1154/6/index.html

[mli]

Job PR-1154/7 is complete. Docs are uploaded to http://gluon-nlp-staging.s3-accelerate.dualstack.amazonaws.com/PR-1154/7/index.html

[eric-haibin-lin]

@StrayBird-ATSH what did you mean by it failed? Are you referring to this error msg?

[2020-02-13T11:55:37.743Z] 

[2020-02-13T11:55:37.743Z] Exception occurred:

[2020-02-13T11:55:37.743Z]   File "/var/lib/jenkins/workspace/gluon-nlp-cpu-py3-master/conda/cpu/py3-master/lib/python3.5/site-packages/mxtheme/card.py", line 25, in run

[2020-02-13T11:55:37.743Z]     cid = nodes.make_id("card-{}".format(options['title']))

[2020-02-13T11:55:37.743Z] KeyError: 'title'

[2020-02-13T11:55:37.743Z] The full traceback has been saved in /tmp/sphinx-err-obhz33o5.log, if you want to report the issue to the developers.

[2020-02-13T11:55:37.743Z] Please also report this if it was a user error, so that a better error message can be provided next time.

[2020-02-13T11:55:37.743Z] A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!

[2020-02-13T11:55:38.303Z] Makefile:57: recipe for target 'html' failed

[2020-02-13T11:55:38.303Z] make[1]: *** [html] Error 2

[2020-02-13T11:55:38.303Z] make[1]: Leaving directory '/var/lib/jenkins/workspace/gluon-nlp-cpu-py3-master/docs'

[2020-02-13T11:55:38.303Z] Makefile:61: recipe for target 'docs' failed

[2020-02-13T11:55:38.303Z] make: *** [docs] Error 2

[eric-haibin-lin]

http://gluon-nlp-staging.s3-accelerate.dualstack.amazonaws.com/PR-1154/7/examples/word_embedding/index.html Looks like there's some rendering issue

[chenw23]

Yes. I was referring to that error messages. That error prevents the entire website from being built. Even though it didn't mention what on earth caused the error, I gradually found out that it was the 4 cards causing it fail. It will compile successfully on 3 cards.

[chenw23]

http://gluon-nlp-staging.s3-accelerate.dualstack.amazonaws.com/PR-1154/7/examples/word_embedding/index.html Looks like there's some rendering issue

Thanks for pointing out this. This seems to be caused by a minor missing space problem. I have already fixed it in the latest commit. For now before the latest compilation finishes, you can preview the website of the 6th commit in this pull request.

Thanks!

[eric-haibin-lin]

@szha are u aware of any limitation on the number of cards for the theme??

[chenw23]

@szha are u aware of any limitation on the number of cards for the theme??

Sorry... It seems that it is the missing indentation among one of the four cards that prevents the cards from compilation. Now I finds it... The cause was so trivial... Now hopefully this problem can be solved.

Perhaps if I didn't put the original three cards on and let the indentation-caused rendering problem come out, I would never realize it was the indentation causing this problem.

[mli]

Job PR-1154/8 is complete. Docs are uploaded to http://gluon-nlp-staging.s3-accelerate.dualstack.amazonaws.com/PR-1154/8/index.html

[mli]

Job PR-1154/9 is complete. Docs are uploaded to http://gluon-nlp-staging.s3-accelerate.dualstack.amazonaws.com/PR-1154/9/index.html

[chenw23]

I think now this pull request should be ready for reviewing and merging. Please give any advice if my refactor doesn't meet what you wish.

[chenw23]

Yes. For the API notes, I plan to deal with them in the next step so that in these pull request, all the changes are concerning existing examples files, for more simplicity. I will change the .md files accordingly. Thanks for your remind.

[mli]

Job PR-1154/10 is complete. Docs are uploaded to http://gluon-nlp-staging.s3-accelerate.dualstack.amazonaws.com/PR-1154/10/index.html

[chenw23]

@eric-haibin-lin For your review. Thanks!

[eric-haibin-lin]

Good job. Look forward to the community page and data/vocab API notes