dmlc / gluon-nlp

NLP made easy
https://nlp.gluon.ai/
Apache License 2.0
2.56k stars 538 forks source link

[website] GluonNLP Website Rework #1081

Open eric-haibin-lin opened 4 years ago

eric-haibin-lin commented 4 years ago

Goal: better feature/model discoverability for the GluonNLP website

Side Navigation Bar

Tutorials

Table Of Content:

Main changes for tutorials

Model Zoo (involves splitting/moving scripts, to be worked on later)

Table Of Content:

Main changes:

Community

installation

eric-haibin-lin commented 4 years ago

Other websites for reference:

eric-haibin-lin commented 4 years ago

@StrayBird-ATSH

chenw23 commented 4 years ago

I will follow up with this issue soon.

sxjscience commented 4 years ago

I think we can revise our documentation page and utilize colab, e.g.,

http://d2l.ai/chapter_recurrent-modern/lstm.html and https://colab.research.google.com/github/d2l-ai/d2l-en-colab/blob/master/chapter_recurrent-modern/lstm.ipynb

eric-haibin-lin commented 4 years ago

I had discussion with @astonzhang about colab. Ideally we should have notebooks on both colab and SageMaker.

sxjscience commented 4 years ago

Yes, we will create runnable notebooks on either colab or sagemaker.

Get Outlook for iOShttps://aka.ms/o0ukef


From: Haibin Lin notifications@github.com Sent: Thursday, December 26, 2019 11:26:56 PM To: dmlc/gluon-nlp gluon-nlp@noreply.github.com Cc: Xingjian SHI xshiab@connect.ust.hk; Comment comment@noreply.github.com Subject: Re: [dmlc/gluon-nlp] [website] GluonNLP Website Rework (#1081)

I had discussion with @astonzhanghttps://github.com/astonzhang about colab. Ideally we should have notebooks on both colab and SageMaker.

— You are receiving this because you commented. Reply to this email directly, view it on GitHubhttps://github.com/dmlc/gluon-nlp/issues/1081?email_source=notifications&email_token=ABHQH3WBURD3SV2F2VOZAW3Q2WU4BA5CNFSM4J7D6GW2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEHWXMJA#issuecomment-569210404, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ABHQH3XK2OP5TZV2QDABJNDQ2WU4BANCNFSM4J7D6GWQ.

eric-haibin-lin commented 4 years ago

I opened a separate github issue for colab/sagemaker integration. https://github.com/dmlc/gluon-nlp/issues/1089

eric-haibin-lin commented 4 years ago

Considering that we will re-implement a few models using numpy, let's focus on re-organizing the following pages first:

Tutorial:

  1. create hierarchies/categories for the tutorials. Specifically, first level is always a category. Inside each category, we have one or more related tutorials.
  2. reorganize existing tutorials/api notes on the website into categories. For the ones from other repositories, we skip them in the first pass.

Community:

  1. add the user gallery mentioned above

For model zoo, it involves restructure the script folders. I'll take a look at the complexity of the scripts and comment later.

sxjscience commented 4 years ago

@eric-haibin-lin I also think that we can use markdowns for basic documentations under scripts: https://github.com/dmlc/gluon-nlp/tree/master/scripts, which is similar to the other packages like fairseq and allennlp. In that case the user can preview the content in the folder without clicking index.rst.

sxjscience commented 4 years ago

@eric-haibin-lin In the numpy version, we will improve the tutorial about tokenization in the Prepare Datasets and Vocabularies section.

chenw23 commented 4 years ago

Since this rework involves a huge amount of work, I will decompose this issue into several steps to achieve its goal. Currently the first pull request is merged with partial goal of this rework completed. In pull request #1108 , I modified the toc structure of the examples part of the website. This refactor enables this part of the website to display multiple level of menus, which is essential for future enhancements. In this pull request, I did not change the contents. In the future pull requests, I will continue to work on the detailed contents update and enhancement that are mentioned in this issue.