dmlc / gluon-nlp

NLP made easy

https://nlp.gluon.ai/

Apache License 2.0

2.56k stars 538 forks source link

Improve Documentation Part 1 #1374

Closed sxjscience closed 3 years ago

sxjscience commented 3 years ago

Description

Improve documentation

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)
[ ] All changes have test coverage
[ ] Code is well-documented

cc @dmlc/gluon-nlp-team

github-actions[bot] commented 3 years ago

The documentation website for preview: http://gluon-nlp-dev.s3-accelerate.amazonaws.com/PR1374/improve_doc/index.html

codecov[bot] commented 3 years ago

Codecov Report

Merging #1374 (e6c39a8) into master (b994b25) will decrease coverage by 0.40%. The diff coverage is 80.32%.

@@            Coverage Diff             @@
##           master    #1374      +/-   ##
==========================================
- Coverage   85.93%   85.53%   -0.41%     
==========================================
  Files          52       52              
  Lines        6912     6912              
==========================================
- Hits         5940     5912      -28     
- Misses        972     1000      +28

Impacted Files	Coverage Δ
src/gluonnlp/__init__.py	`100.00% <ø> (ø)`
src/gluonnlp/attention_cell.py	`86.91% <ø> (ø)`
src/gluonnlp/data/filtering.py	`78.26% <ø> (-4.35%)`	:arrow_down:
src/gluonnlp/data/tokenizers/base.py	`87.95% <ø> (ø)`
src/gluonnlp/data/tokenizers/spacy.py	`66.23% <ø> (ø)`
src/gluonnlp/models/base.py	`56.52% <56.52%> (ø)`
src/gluonnlp/models/electra.py	`76.83% <60.00%> (ø)`
src/gluonnlp/base.py	`100.00% <100.00%> (ø)`
src/gluonnlp/layers.py	`87.11% <100.00%> (ø)`
src/gluonnlp/models/__init__.py	`100.00% <100.00%> (+3.12%)`	:arrow_up:
... and 14 more

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update b994b25...e6c39a8. Read the comment docs.

github-actions[bot] commented 3 years ago

The documentation website for preview: http://gluon-nlp-dev.s3-accelerate.amazonaws.com/PR1374/improve_doc/index.html

github-actions[bot] commented 3 years ago

The documentation website for preview: http://gluon-nlp-staging.s3-accelerate.dualstack.amazonaws.com/PR1374/improve_doc/index.html

github-actions[bot] commented 3 years ago

The documentation website for preview: http://gluon-nlp-staging.s3-accelerate.dualstack.amazonaws.com/PR1374/improve_doc/index.html

github-actions[bot] commented 3 years ago

The documentation website for preview: http://gluon-nlp-staging.s3-accelerate.dualstack.amazonaws.com/PR1374/improve_doc/index.html

github-actions[bot] commented 3 years ago

The documentation website for preview: http://gluon-nlp-staging.s3-accelerate.dualstack.amazonaws.com/PR1374/improve_doc/index.html

github-actions[bot] commented 3 years ago

The documentation website for preview: http://gluon-nlp-staging.s3-accelerate.dualstack.amazonaws.com/PR1374/improve_doc/index.html

github-actions[bot] commented 3 years ago

The documentation website for preview: http://gluon-nlp-staging.s3-accelerate.dualstack.amazonaws.com/PR1374/improve_doc/index.html

github-actions[bot] commented 3 years ago

The documentation website for preview: http://gluon-nlp-staging.s3-accelerate.dualstack.amazonaws.com/PR1374/improve_doc/index.html

github-actions[bot] commented 3 years ago

The documentation website for preview: http://gluon-nlp-staging.s3-accelerate.dualstack.amazonaws.com/PR1374/improve_doc/index.html

sxjscience commented 3 years ago

@szha The first version should be ready. Need some help in improving it + Add it to our official website.

github-actions[bot] commented 3 years ago

The documentation website for preview: http://gluon-nlp-staging.s3-accelerate.dualstack.amazonaws.com/PR1374/improve_doc/index.html

github-actions[bot] commented 3 years ago

The documentation website for preview: http://gluon-nlp-staging.s3-accelerate.dualstack.amazonaws.com/PR1374/improve_doc/index.html

github-actions[bot] commented 3 years ago

The documentation website for preview: http://gluon-nlp-staging.s3-accelerate.dualstack.amazonaws.com/PR1374/improve_doc/index.html

github-actions[bot] commented 3 years ago

The documentation website for preview: http://gluon-nlp-staging.s3-accelerate.dualstack.amazonaws.com/PR1374/improve_doc/index.html

github-actions[bot] commented 3 years ago

The documentation website for preview: http://gluon-nlp-staging.s3-accelerate.dualstack.amazonaws.com/PR1374/improve_doc/index.html

github-actions[bot] commented 3 years ago

The documentation website for preview: http://gluon-nlp-staging.s3-accelerate.dualstack.amazonaws.com/PR1374/improve_doc/index.html

github-actions[bot] commented 3 years ago

The documentation website for preview: http://gluon-nlp-staging.s3-accelerate.dualstack.amazonaws.com/PR1374/improve_doc/index.html

github-actions[bot] commented 3 years ago

The documentation website for preview: http://gluon-nlp-staging.s3-accelerate.dualstack.amazonaws.com/PR1374/improve_doc/index.html

github-actions[bot] commented 3 years ago

The documentation website for preview: http://gluon-nlp-staging.s3-accelerate.dualstack.amazonaws.com/PR1374/improve_doc/index.html

szha commented 3 years ago

Thanks for fixing all the doc warnings. I'm turning on website pipeline check as required to make sure the working state is maintained.