Skip to content
This repository was archived by the owner on Jan 15, 2024. It is now read-only.

Conversation

eric-haibin-lin
Copy link
Member

Description

The website API doc does not include nlp.utils APIs.

Checklist

Essentials

  • PR's title starts with a category (e.g. [BUGFIX], [MODEL], [TUTORIAL], [FEATURE], [DOC], etc)
  • Changes are complete (i.e. I finished coding on this PR)
  • All changes have test coverage
  • 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

@eric-haibin-lin eric-haibin-lin requested a review from a team as a code owner September 21, 2019 23:42
@codecov
Copy link

codecov bot commented Sep 21, 2019

Codecov Report

Merging #936 into master will decrease coverage by 13.69%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #936      +/-   ##
==========================================
- Coverage   89.95%   76.25%   -13.7%     
==========================================
  Files          67       67              
  Lines        6360     6360              
==========================================
- Hits         5721     4850     -871     
- Misses        639     1510     +871
Impacted Files Coverage Δ
src/gluonnlp/data/batchify/embedding.py 17.32% <0%> (-80.32%) ⬇️
src/gluonnlp/data/candidate_sampler.py 19.23% <0%> (-73.08%) ⬇️
src/gluonnlp/optimizer/lamb.py 23.8% <0%> (-66.67%) ⬇️
src/gluonnlp/utils/version.py 33.33% <0%> (-66.67%) ⬇️
src/gluonnlp/utils/parallel.py 34.04% <0%> (-63.83%) ⬇️
src/gluonnlp/optimizer/bert_adam.py 27.45% <0%> (-58.83%) ⬇️
src/gluonnlp/utils/parameter.py 23.72% <0%> (-57.63%) ⬇️
src/gluonnlp/loss/activation_regularizer.py 35.48% <0%> (-51.62%) ⬇️
...p/data/corpora/large_text_compression_benchmark.py 40.74% <0%> (-50%) ⬇️
src/gluonnlp/loss/loss.py 50% <0%> (-43.75%) ⬇️
... and 24 more

@mli
Copy link
Member

mli commented Sep 22, 2019

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

@szha
Copy link
Member

szha commented Sep 22, 2019

We will need to improve the code coverage of the utils module.

@eric-haibin-lin
Copy link
Member Author

I'm not sure why this PR affects the code coverage.. Every API under nlp.utils are tested in https://github.com/dmlc/gluon-nlp/blob/master/tests/unittest/test_utils.py

@eric-haibin-lin eric-haibin-lin merged commit 5dec318 into dmlc:master Sep 22, 2019
@eric-haibin-lin eric-haibin-lin deleted the missing-doc branch February 2, 2020 06:23
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants