Skip to content

[FA] First draft of Chapter2/Page2#129

Merged
lewtun merged 13 commits into
huggingface:mainfrom
jowharshamshiri:main
Apr 20, 2022
Merged

[FA] First draft of Chapter2/Page2#129
lewtun merged 13 commits into
huggingface:mainfrom
jowharshamshiri:main

Conversation

@jowharshamshiri

Copy link
Copy Markdown
Contributor

Added chapter 2/page2
updated _toctree.yml
Additions to the glossary
Created TRANSLATING.txt

Related to #50

@jowharshamshiri jowharshamshiri mentioned this pull request Apr 20, 2022
69 tasks
@HuggingFaceDocBuilderDev

HuggingFaceDocBuilderDev commented Apr 20, 2022

Copy link
Copy Markdown

The documentation is not available anymore as the PR was closed or merged.

@jowharshamshiri

jowharshamshiri commented Apr 20, 2022

Copy link
Copy Markdown
Contributor Author

Hi @lewtun I have a question about this passage in the original text(CH2/P2):

The vector output by the Transformer module is usually large. It generally has three dimensions:

- **Batch size**: The number of sequences processed at a time (2 in our example).
- **Sequence length**: The length of the numerical representation of the sequence (16 in our example).
- **Hidden size**: The vector dimension of each model input.

It is said to be "high dimensional" because of the last value. The hidden size can be very large (768 is common for smaller models, and in larger models this can reach 3072 or more).

Reading this and trying to translate it faithfully, I was confused as to what the original text meant. Especially since earlier in the page you talk about the difference btw scalars and vectors and matrices in math, and here switch to talking about NumPy vectors. I have the Persian equivalent of this passage in my translation. It has a few subtle differences, mainly that it implies this is a Python vector by mentioning the shape attribute:

The vector output by the Transformer module is usually large. Information about these vectors is available in the `shape` attribute that generally has three dimensions:

- **Batch size**: The number of sequences processed at a time (2 in our example).
- **Sequence length**: The length of the numerical representation of the sequence (16 in our example).
- **Hidden size**: The vector dimension of each model input.

The hidden size can be very large (768 is common for smaller models, and in larger models this can reach 3072 or more) and that's why the output is said to be "high dimensional".

Does this make sense to you? or should I switch back?

@lewtun

lewtun commented Apr 20, 2022

Copy link
Copy Markdown
Member

Thanks for adding this new section @jowharshamshiri 🤗 !

Regarding your question, I think we want to avoid mentioning shape since that's a PyTorch / NumPy specific attribute. To be precise, we could use "tensor" and say

the output from the Transformer module is a tensor that typically has three dimensions:

Would the translation of that sentence make more sense in Persian?

@@ -0,0 +1,67 @@
1. Use this style guide for Persian. https://apll.ir/wp-content/uploads/2018/10/D-1394.pdf

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Great job on providing these detailed instructions!

@jowharshamshiri

jowharshamshiri commented Apr 20, 2022

Copy link
Copy Markdown
Contributor Author

Thanks for adding this new section @jowharshamshiri hugs !

Regarding your question, I think we want to avoid mentioning shape since that's a PyTorch / NumPy specific attribute. To be precise, we could use "tensor" and say

the output from the Transformer module is a tensor that typically has three dimensions:

Would the translation of that sentence make more sense in Persian?

Yes it works, thanks for the clarification. 🤗

@lewtun

lewtun commented Apr 20, 2022

Copy link
Copy Markdown
Member

Great, merging this and will deploy on hf.co later today - thanks again for your great work @jowharshamshiri 🤗 !

@lewtun
lewtun merged commit dea95d5 into huggingface:main Apr 20, 2022
@jowharshamshiri

Copy link
Copy Markdown
Contributor Author

Great, merging this and will deploy on hf.co later today - thanks again for your great work @jowharshamshiri hugs !

Far too kind. Thank you for writing this material.

lewtun added a commit that referenced this pull request Apr 25, 2022
* ko-chapter1/1

* ko _toctree.yml created

* Fix the issue #80

* Single expression changed

* ko/chapter1 finished

* ko/chapter0 finished

* ko/chapter0 finished

* reviewed by @bzantium ko/chapter0

* reviewed by @bzantium chapter0 & fixed typo

* reviewed by @rainmaker712

* maximize Korean expressions

* [Chapter 1] bangla traslation initial commit

* Update 1.mdx

update and fix formating

* Fix formating and typos

* translate _toctree.yml 0-1 chapter

* Add Korean to CI

* [tr] Translated chapter1/2.mdx

* remove translation from sec titles not yet translated

* Add authors [th ru]

* [FIX] _toctree.yml

* Update chapters/bn/chapter0/1.mdx

[FIX] syntax formatting

Co-authored-by: lewtun <[email protected]>

* tag typos & indentation & unnatural expressions

* modified toctree.yml for chapter1/2

* modified toctree.yml for chapter1/2 & fix typo

* French Translation - Chapter 5

* Add Bengali to CI

* Update author list

* Adding translations for 2/4 and 2/5 🚀 (#74)

* Adding translations for 2/4 and 2/5 🚀

* Remove English content

Co-authored-by: lewtun <[email protected]>

* Translation to Russian (#97)

* translation of chapter 2/section 1

* add section 1 / chapter 2 to _toctree.yml

* Translation of Chapter0 to Hindi (#86)

* Hindi?Chapter0-Part_1

* Hindi/Chapter0-Part_2

* Chapter 0 Persian Translation First Draft (#95)

* merged branch0 into main. no toctree yet.

* updated toctree.

* Updated the glossary with terms from chapter0.

* Second draft in collab w/ @schoobani. Added empty chapter1 for preview.

* Glossary typo fix.

* Translation of Chapter0 (setup) to Arabic (#104)

* Add AR translation for `introduction`

* Fix alignment & format

* Add Arabic to CI build

* Russian - Chapter 1 finished (#98)

* 01/4 start

* 1/4 finished

* 1/5 finished

* 1/5 update toc

* 1/6 finished

* 1/7 finished

* 1/8 finished

* 1/9 finished

* 1/4 fix

* toc update

* Chinese - Chapter 1 finished (#113)

* Chinese - Chapter 1 finished

* Add zh to the languages field

Co-authored-by: petrichor1122 <[email protected]>
Co-authored-by: zhlhyx <[email protected]>

* [PT] Translation of chapter 2 (#107)

* add PT translate to 2.1

* add PT translate to 2.2

* add portuguese translation to 2.3

* WIP portuguese translation to 2.4

* add portuguese translation to 2.4

* add portuguese translation to 2.5

* add portuguese translation to 2.6

* add _toctree infos

Co-authored-by: lewtun <[email protected]>

* [FR] Translation of chapter 2 & event + Review of chapters 0 & 5 (#106)

* Update _toctree.yml

Add chapter 2 
+ little fix of chapter 5

* Update 1.mdx

Review of chapter 0

* Create 1.mdx

* Create 2.mdx

* Create 3.mdx

* Create 4.mdx

* Create 5.mdx

* Create 6.mdx

* Create 7.mdx

* Create 8.mdx

* Update 8.mdx

Since AutoNLP has recently been renamed to AutoTrain, let me make the correction on the English file

* Update 1.mdx

Review of chapter 5/1

* Update 2.mdx

Review of chapter 5/2

* Update 3.mdx

Review of chapter 5/3

* Update 4.mdx

Review of chapter 5/4

* Update 5.mdx

Review of chapter 5/5

* Update 6.mdx

Review of chapter 5/6

* Update 7.mdx

Review of chapter 5/7

* Update 8.mdx

Review of chapter 5/8

* Create 1.mdx

event's translation

* Update _toctree.yml

add event to the tree

* Update _toctree.yml

deletion of the files that pose a problem to pass the checks, will be resubmitted in another PR

* Delete 1.mdx

deletion of the files that pose a problem to pass the checks, will be resubmitted in another PR

* make style correction

* Update _toctree.yml

the -

* Fix spacing

Co-authored-by: Lewis Tunstall <[email protected]>

* [th] Translated Chapter2/1 (#83)

* Finish chapter2/1

* Update _toctree.yml

* Add Hindi to CI (#116)

* Update README.md (#87)

* Update authors on README (#120)

* Update authors

* French translation `Chapter1` full (#56)


* traduction 1st part of chapter1

* fix typo

* fix job titles and encoder-decoder translation

* add part 2 for 1st chapter

* fix some typo part2

* fix Transformer -> Transformers

* add part 3 not totally ended

* end of part3 of chapter1

* part9 chapter 1

* add part7 chapter 1

* add part5 chapter 1

* part 6 chapter 1

* add part8 chapter 1

* end quizz of chapter

* add last part of chapter 1

Co-authored-by: ChainYo <[email protected]>

* Translate to Japanese Chapter0 (#123)

* start working

* translate chapter0/1.mdx

* [FA] First draft of Chapter2/Page2 (#129)

* merged branch0 into main. no toctree yet.

* updated toctree.

* Updated the glossary with terms from chapter0.

* Second draft in collab w/ @schoobani. Added empty chapter1 for preview.

* Glossary typo fix.

* Added missing backticks.

* Removed a couple of bad indefinite articles I forgot.

* First draft of ch2/p2. Adds to glossary. Trans. guidelines moved out.

* Fixed missing diacritics, fixed the py/tf switch placing. Other fixes.

* Changed the equivalent for prediction per @kambizG 's direction.

* Redid ambiguous passage in translation per @lewtun 's direction.

* [th] Finished whole Chapter 2 translation (#127)

* Finish chapter2/1

* delete untranslated files

* chapter2/2 WIP

* Delete WIP files

* WIP chapter2/2

* Fixed conflict

* Update _toctree.yml

* Update _toctree.yml

* Finished Chapter2/2

* Finish all chapter2/n

* Finish all chapter2/n

* Fixed Ch2/8 as PR run failed

* [de] Translation Chapter 0 (#130)

* Copy files to newly created german dir (de)

* Add translation for chapter 0

* Clean up english files for chapter 1

* Change _toctree.yml for chapter 0

* Fix whitespaces

* Fix whitespaces again

* Adjust _toctree.yml - leave only chaper 0

* Add German language (de) to workflow yaml files

* [de] German Translation Guide (#132)

* German Translation Guide

* Add German Glossary to TOC

* Chapter 1, Section 1 Bengali translation (#124)

* [ADD] Chapter 1, Section 1 benglai tranlation

* [FIX] toc

* [FIX] commit mistakes

* [FIX] remove the Eng duplicates

Co-authored-by: m_khandaker <[email protected]>

* [FR] Review of chapters 0, 2 & 5 + add chapters 6, 7, 8 & event (#125)

* Create 1.mdx

Event translation

* Create 1.mdx

* Chapter 6 in French

* Update 1.mdx

fix italic

* Update 9.mdx

fix italic

* Update 3.mdx

fix italic

* Update 4.mdx

fix italic

* Update 4.mdx

* Update 1.mdx

little fix

* Update 2.mdx

little fix

* Update 4.mdx

fix italic

* Update 8.mdx

fix italic

* Update 1.mdx

little fix

* Update 2.mdx

little fix

* Update 3.mdx

little fix

* Update 5.mdx

little fix

* Update 7.mdx

little fix

* Update 8.mdx

little fix

* add chapter8

* Update 6.mdx

fix italic

* Update 3.mdx

fix, fix everywhere

* Update 2.mdx

fix, fix everywhere

* Update 4.mdx

fix, fix everywhere

* Update 4_tf.mdx

fix, fix everywhere

* Add files via upload

add chapter 7

* Update 1.mdx

fix links

* Update 2.mdx

fix, fix everywhere

* Update 3.mdx

fix, fix everywhere

* Update 4.mdx

fix, fix everywhere

* Update 5.mdx

* Update 6.mdx

fix, fix everywhere

* Update 7.mdx

fix, fix everywhere

* Update 3.mdx

fix link

* Update 8.mdx

fix link

* Update 2.mdx

fix link

* Update 4.mdx

little fix

* Update 6.mdx

* Update 7.mdx

* Update 8.mdx

fix

* Update 2.mdx

little fix

* Update 3.mdx

little fix

* Update 5.mdx

* Update 4_tf.mdx

little fix

* Update _toctree.yml

Forgot the toctree

* Update _toctree.yml

fix local fields

* Update _toctree.yml

My bad, I forgot some 🙃

* Update 7.mdx

I don't know why it was there...

* Update 1.mdx

* [de] Chapter 3 translation (#128)

* chapter 3 part 1 DE

* [DE] Chapter 3 - Part 2

* Prepare TOC-Tree

* Fein-tuning

* Initial translation

* Glossary additions for C3P3

* C3P2 style

* [de] Chapter 3 P3-TF initial translation

* [de] Chapter 3 P4 initial translation

* [de] Chapter 3 Part 5 initial translation

* [de] Chapter 3 P6 Initial translation

* Missing commas

* fixing quotes

* Mark third option on chapter 8, question 8 as correct (#135)

* doc_change(translation): translating course from english to gujarati (#126)

* change(translation): chapter0 to gujarati

content translated: Chapter0/1.mdx - Introduction

commit-by: [email protected]

* Revert "change(translation): chapter0 to gujarati"

This reverts commit c27e069.

* doc_change(translation): translation to gj

translated content: chapters/gj/chapter0.mdx - introduction

* doc_change(translation): translation to gj

translated content: chapters/gj/chapter0.mdx - introduction

* Delete _toctree.yml

* change: adding gj to github workflow

* nit: fix heading

* Update authors (#136)

* [FA] First draft of Chapter4/Page1 (#134)

* added chapter4 title and it's first section

* added first draft of Chapter4/Page1

* minor fix

* updated the title according to convention

* applied some updates according to convention

* added footnotes, minor improvements

* applied tweaks according to review points

* the new draft of glossary according to PR #134

* fixed an inconsistant title

* minor fix for better compatibility with T points

* applied final touches for this round of G updates

* [FR] End of chapter 3 + chapter 4  (#137)

* add chapters 3 & 4

* Update 2.mdx

fix links

* Update 3.mdx

some fix

* Update 6.mdx

fix tag

* Update 3.mdx

add link to chapter 7

* Update 3_tf.mdx

add link to chapter 7

* Update _toctree.yml

Co-authored-by: DOOHAE JUNG <[email protected]>
Co-authored-by: m_khandaker <[email protected]>
Co-authored-by: Md. Al-Amin Khandaker <[email protected]>
Co-authored-by: ftarlaci <[email protected]>
Co-authored-by: Doohae Jung <[email protected]>
Co-authored-by: melaniedrevet <[email protected]>
Co-authored-by: Jose M Munoz <[email protected]>
Co-authored-by: svv73 <[email protected]>
Co-authored-by: Vedant Pandya <[email protected]>
Co-authored-by: Bahram Shamshiri <[email protected]>
Co-authored-by: Giyaseddin Bayrak <[email protected]>
Co-authored-by: Pavel <[email protected]>
Co-authored-by: 1375626371 <[email protected]>
Co-authored-by: petrichor1122 <[email protected]>
Co-authored-by: zhlhyx <[email protected]>
Co-authored-by: João Gustavo A. Amorim <[email protected]>
Co-authored-by: lbourdois <[email protected]>
Co-authored-by: Cherdsak Kingkan <[email protected]>
Co-authored-by: Thomas Chaigneau <[email protected]>
Co-authored-by: ChainYo <[email protected]>
Co-authored-by: hiromu <[email protected]>
Co-authored-by: Cherdsak Kingkan <[email protected]>
Co-authored-by: Marcus Fraaß <[email protected]>
Co-authored-by: Jesper Dramsch <[email protected]>
Co-authored-by: amyeroberts <[email protected]>
Co-authored-by: Ash <[email protected]>
Co-authored-by: Hamed Homaei Rad <[email protected]>