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

[DOC] fix math formula in docs #920

Merged
merged 4 commits into from
Sep 11, 2019
Merged

[DOC] fix math formula in docs #920

merged 4 commits into from
Sep 11, 2019

Conversation

liusy182
Copy link
Contributor

@liusy182 liusy182 commented Sep 6, 2019

Description

Fix the math formula in docs for gluonnlp.model.LSTMPCellWithClip. There is an extra } that caused formula not displaying as expected. Attached with documentation website screenshot to show the problem.

before

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

@liusy182 liusy182 requested a review from szha as a code owner September 6, 2019 21:57
@codecov
Copy link

codecov bot commented Sep 6, 2019

Codecov Report

❗ No coverage uploaded for pull request head (fix-latex@31f9341). Click here to learn what that means.
The diff coverage is n/a.

@codecov
Copy link

codecov bot commented Sep 6, 2019

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #920      +/-   ##
==========================================
- Coverage   89.71%   88.55%   -1.16%     
==========================================
  Files          66       66              
  Lines        6405     6405              
==========================================
- Hits         5746     5672      -74     
- Misses        659      733      +74
Impacted Files Coverage Δ
src/gluonnlp/model/lstmpcellwithclip.py 100% <ø> (ø) ⬆️
src/gluonnlp/data/batchify/embedding.py 46.87% <0%> (-50.79%) ⬇️
src/gluonnlp/vocab/subwords.py 59.43% <0%> (-21.7%) ⬇️
src/gluonnlp/model/parameter.py 92% <0%> (-8%) ⬇️
src/gluonnlp/data/corpora/wikitext.py 94.82% <0%> (-5.18%) ⬇️
src/gluonnlp/data/transforms.py 77.13% <0%> (-4.58%) ⬇️
src/gluonnlp/data/batchify/batchify.py 93.18% <0%> (-3.41%) ⬇️
src/gluonnlp/data/dataset.py 97.61% <0%> (-1.59%) ⬇️
src/gluonnlp/data/word_embedding_evaluation.py 96.21% <0%> (-0.76%) ⬇️
src/gluonnlp/model/sequence_sampler.py 91.69% <0%> (+16.95%) ⬆️

@mli
Copy link
Member

mli commented Sep 6, 2019

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

@szha
Copy link
Member

szha commented Sep 8, 2019

@mli
Copy link
Member

mli commented Sep 11, 2019

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

@mli
Copy link
Member

mli commented Sep 11, 2019

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

@liusy182
Copy link
Contributor Author

@szha thanks. Fixed with the new commit: link

Copy link
Contributor

@leezu leezu left a comment

Choose a reason for hiding this comment

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

Great, thank you!

@mli
Copy link
Member

mli commented Sep 11, 2019

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

@szha szha merged commit 5329e00 into dmlc:master Sep 11, 2019
@szha
Copy link
Member

szha commented Sep 11, 2019

@liusy182 merged. Thank you for the fix!

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.

5 participants