Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] fix model_doc links in model summary #5566

Merged
merged 2 commits into from
Jul 7, 2020

Conversation

patil-suraj
Copy link
Contributor

Possible fix for #5561

@sgugger

@codecov
Copy link

codecov bot commented Jul 7, 2020

Codecov Report

Merging #5566 into master will increase coverage by 0.35%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #5566      +/-   ##
==========================================
+ Coverage   77.20%   77.55%   +0.35%     
==========================================
  Files         141      141              
  Lines       24638    24638              
==========================================
+ Hits        19021    19108      +87     
+ Misses       5617     5530      -87     
Impacted Files Coverage Δ
src/transformers/modeling_tf_openai.py 20.78% <0.00%> (-74.20%) ⬇️
src/transformers/tokenization_xlm_roberta.py 61.90% <0.00%> (-33.34%) ⬇️
src/transformers/tokenization_auto.py 95.55% <0.00%> (-2.23%) ⬇️
src/transformers/modeling_openai.py 79.72% <0.00%> (-1.38%) ⬇️
src/transformers/configuration_utils.py 95.68% <0.00%> (-0.72%) ⬇️
src/transformers/generation_tf_utils.py 86.21% <0.00%> (-0.26%) ⬇️
src/transformers/generation_utils.py 97.11% <0.00%> (+0.28%) ⬆️
src/transformers/tokenization_utils_base.py 93.60% <0.00%> (+1.16%) ⬆️
src/transformers/tokenization_transfo_xl.py 42.48% <0.00%> (+8.92%) ⬆️
src/transformers/modeling_tf_roberta.py 93.04% <0.00%> (+49.56%) ⬆️
... and 1 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 1d23328...028e84a. Read the comment docs.

@sgugger
Copy link
Collaborator

sgugger commented Jul 7, 2020

No, this won't work across versions (if you switch to master docs for instance). The problem is in the first slash, I think removing it should be enough to make all link works.

@sgugger
Copy link
Collaborator

sgugger commented Jul 7, 2020

Double-checked locally, this is the right fix: /model_doc/gpt -> model_doc/gpt

@patil-suraj
Copy link
Contributor Author

should I make these changes ? also model_doc/gpt or model_doc/gpt.html ?

@sgugger
Copy link
Collaborator

sgugger commented Jul 7, 2020

No need for the .html.
I can force-push on your branch or let you do the changes, your call!

Copy link
Collaborator

@sgugger sgugger left a comment

Choose a reason for hiding this comment

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

Thanks a lot!

@sgugger sgugger merged commit 33e43ed into huggingface:master Jul 7, 2020
@mikaelsouza
Copy link
Contributor

How much time does it take to these changes be reflected in the website?

Also, can I close my issue after this fix?

@sgugger

Thanks! :)

@sgugger
Copy link
Collaborator

sgugger commented Jul 7, 2020

The thing is that the bug will probably stay in the stable version of the doc forever (unless we manage to cherry-pick it somehow @LysandreJik ?). It is reflected in the master version already.

You can close your issue whenever you like :-)

LysandreJik pushed a commit that referenced this pull request Jul 9, 2020
* fix model_doc links

* update model links
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants