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.

Sign up for GitHub

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

Jump to bottom

[doc] multiple corrections to "Summary of the tasks" #6509

Merged
merged 4 commits into from
Aug 17, 2020
Merged

[doc] multiple corrections to "Summary of the tasks" #6509

merged 4 commits into from
Aug 17, 2020

Conversation

stas00
Copy link
Contributor

@stas00 stas00 commented Aug 16, 2020 •
edited
Loading

  • improve readability - typos, punctuation, clearer sentences, numerical bullets where needed
  • fix incorrect script names
  • add missing scripts and add hyper links where missing
  • a minor code improvement to improve understanding at the very last section (replaced output ids with translated text)

One thing I didn't know how to fix is the outdated referance to a script that no longer exists:

If you would like to fine-tune a model on a summarization task, you may leverage the examples/summarization/bart/run_train.sh (leveraging pytorch-lightning) script.

@sgugger

@codecov
Copy link

codecov bot commented Aug 16, 2020 •
edited
Loading

Codecov Report

Merging #6509 into master will decrease coverage by 1.16%.
The diff coverage is 0.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #6509      +/-   ##
==========================================
- Coverage   80.37%   79.21%   -1.17%     
==========================================
  Files         156      156              
  Lines       28058    28058              
==========================================
- Hits        22552    22225     -327     
- Misses       5506     5833     +327
Impacted Files Coverage Δ
src/transformers/configuration_utils.py 95.91% <ø> (-0.69%) ⬇️
src/transformers/generation_tf_utils.py 83.95% <ø> (-2.51%) ⬇️
src/transformers/generation_utils.py 96.94% <ø> (ø)
src/transformers/trainer.py 37.84% <0.00%> (ø)
src/transformers/modeling_tf_openai.py 22.58% <0.00%> (-72.26%) ⬇️
src/transformers/tokenization_xlm.py 16.26% <0.00%> (-66.67%) ⬇️
src/transformers/modeling_tf_flaubert.py 24.53% <0.00%> (-63.81%) ⬇️
src/transformers/tokenization_marian.py 66.66% <0.00%> (-32.50%) ⬇️
src/transformers/tokenization_gpt2.py 87.50% <0.00%> (-9.73%) ⬇️
src/transformers/tokenization_transfo_xl.py 33.56% <0.00%> (-8.93%) ⬇️
... and 13 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 24107c2...bd1f4c5. Read the comment docs.

sgugger
sgugger approved these changes Aug 17, 2020
View reviewed changes
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.

Great work! We just have to fin that missing script ;-)

docs/source/task_summary.rst Outdated Show resolved Hide resolved
@sgugger
Copy link
Collaborator

sgugger commented Aug 17, 2020

Good to go thanks. (side-note: we tend to default to two underscores for links as otherwise, sphinx will always associate the description to the same link).

@sgugger sgugger merged commit b732e7e into huggingface:master Aug 17, 2020
@stas00 stas00 mentioned this pull request Aug 17, 2020
Merged
@stas00
Copy link
Contributor Author

stas00 commented Aug 17, 2020

side-note: we tend to default to two underscores for links as otherwise, sphinx will always associate the description to the same link

I will know now - thank you: fixed here #6541

@stas00 stas00 deleted the patch-3 branch August 17, 2020 16:10
Zigur pushed a commit to Zigur/transformers that referenced this pull request Oct 26, 2020
@stas00 @Zigur
[doc] multiple corrections to "Summary of the tasks" (huggingface#6509)
af137cf 
* [doc] multiple corrections to "Summary of the tasks"

* fix indentation

* correction

* fix links, add links to examples/seq2seq/README.md instead of non-existing script
fabiocapsouza pushed a commit to fabiocapsouza/transformers that referenced this pull request Nov 15, 2020
@stas00 @fabiocapsouza
[doc] multiple corrections to "Summary of the tasks" (huggingface#6509)
fb5429c 
* [doc] multiple corrections to "Summary of the tasks"

* fix indentation

* correction

* fix links, add links to examples/seq2seq/README.md instead of non-existing script
fabiocapsouza added a commit to fabiocapsouza/transformers that referenced this pull request Nov 15, 2020
@fabiocapsouza
Revert "[doc] multiple corrections to "Summary of the tasks" (hugging…
8feb3bc 
…face#6509)"

This reverts commit fb5429c.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sshleifer sshleifer sshleifer left review comments

@sgugger sgugger sgugger approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@stas00 @sgugger @sshleifer