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

[i18n-ar] Translated file : docs/source/ar/glossary.md into Arabic #33038

Conversation

AhmedAlmaghz
Copy link
Contributor

What does this PR do?

Translated the docs/source/ar/glossary.md file of the documentation to Arabic العربية. I use transformers for my side-project and wanted to contribute. As a beginner, this seemed appropriate.

Some questions:

  • I can't access the pr documentation endpoint for Arabic العربية. Is there a missing step?
  • I left all the other files alone after copying the English docs. Is this acceptable for future updates or should I add contents to the _toctree.yml only when translation is complete? Should I delete all other files for a cleaner review?
  • In Arabic, people use both Transformer and المحولات to describe the model. However, as this is more of a product of HuggingFace I opted not to translate it. May you please let me know which you would prefer?

Thank you in advance for your review.

Part of #32435

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline, Pull Request section?
  • Was this discussed/approved via a Github issue or the forum ?Please add a link to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the documentation guidelines, and here are tips on formatting docstrings.
  • Did you write any new necessary tests?

Who can review?

@stevhliu , @MKhalusova , @abodacs, may you please review this PR?

Copy link
Contributor

@abodacs abodacs left a comment

Choose a reason for hiding this comment

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

@AhmedAlmaghz
بدأت فى المراحعة

هل يمكن إضافة المصطلح باللغة الانجليزية ما بين اقواس عند تعريفه أول مره ؟
مثال

قناع الانتباه (Attention Mask)

docs/source/ar/glossary.md Outdated Show resolved Hide resolved
docs/source/ar/glossary.md Outdated Show resolved Hide resolved
docs/source/ar/glossary.md Outdated Show resolved Hide resolved
docs/source/ar/glossary.md Outdated Show resolved Hide resolved
docs/source/ar/glossary.md Outdated Show resolved Hide resolved
docs/source/ar/glossary.md Outdated Show resolved Hide resolved
docs/source/ar/glossary.md Outdated Show resolved Hide resolved
docs/source/ar/glossary.md Outdated Show resolved Hide resolved
docs/source/ar/glossary.md Show resolved Hide resolved
docs/source/ar/glossary.md Outdated Show resolved Hide resolved
@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@stevhliu
Copy link
Member

I can't access the pr documentation endpoint for Arabic العربية. Is there a missing step?

Once #32696 is merged, the doc-builder will generate a preview for Arabic.

I left all the other files alone after copying the English docs. Is this acceptable for future updates or should I add contents to the _toctree.yml only when translation is complete? Should I delete all other files for a cleaner review?

Yeah, you can just work on one file at a time. In the future, once #32696 is merged, you'll add the translated doc to the toctree so it'll look like:

- title: Get started
  sections:
  - local: index
    title: 🤗 المحولات
- sections
  - local: glossary
    title: (قاموس المصطلحات (قائمة الكلمات

In Arabic, people use both Transformer and المحولات to describe the model. However, as this is more of a product of HuggingFace I opted not to translate it. May you please let me know which you would prefer?

When referring to a transformer model in general, you can translate it. When referring to Transformers the library, you can leave it untranslated.

Copy link
Contributor

@abodacs abodacs left a comment

Choose a reason for hiding this comment

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

@AhmedAlmaghz
شكرا على مجهودك ومبادرتك
تتم المراجعة الPR

docs/source/ar/glossary.md Outdated Show resolved Hide resolved
docs/source/ar/glossary.md Outdated Show resolved Hide resolved
docs/source/ar/glossary.md Outdated Show resolved Hide resolved
docs/source/ar/glossary.md Outdated Show resolved Hide resolved
docs/source/ar/glossary.md Outdated Show resolved Hide resolved
docs/source/ar/glossary.md Outdated Show resolved Hide resolved
docs/source/ar/glossary.md Outdated Show resolved Hide resolved
docs/source/ar/glossary.md Outdated Show resolved Hide resolved
docs/source/ar/glossary.md Outdated Show resolved Hide resolved
docs/source/ar/glossary.md Outdated Show resolved Hide resolved
@AhmedAlmaghz AhmedAlmaghz marked this pull request as ready for review August 29, 2024 18:00
@AhmedAlmaghz
Copy link
Contributor Author

AhmedAlmaghz commented Aug 29, 2024

@abodacs
التالي :
🤗 Transformers #33040
Quick tour #33069
Installation #33041

Copy link
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

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

Cool thanks, there are just a few missing things

docs/source/ar/glossary.md Outdated Show resolved Hide resolved
docs/source/ar/glossary.md Outdated Show resolved Hide resolved
docs/source/ar/glossary.md Outdated Show resolved Hide resolved
docs/source/ar/glossary.md Outdated Show resolved Hide resolved
docs/source/ar/glossary.md Outdated Show resolved Hide resolved
docs/source/ar/glossary.md Outdated Show resolved Hide resolved
docs/source/ar/glossary.md Outdated Show resolved Hide resolved
docs/source/ar/glossary.md Outdated Show resolved Hide resolved
AhmedAlmaghz and others added 8 commits August 30, 2024 20:02
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
AhmedAlmaghz added a commit to AhmedAlmaghz/transformers that referenced this pull request Oct 5, 2024
Add Translate docs into Arabic - section files CONCEPTUAL GUIDES
---------------------------------------------------------------------------------------
 Philosophy [i18n-ar] Translated file : docs/source/ar/philosophy.md into Arabic huggingface#33064
 Glossary [i18n-ar] Translated file : docs/source/ar/glossary.md into Arabic huggingface#33038
 What 🤗 Transformers can do [i18n-ar] Translated file : docs/source/ar/task_summary.md into Arabic huggingface#33073
 How 🤗 Transformers solve tasks [i18n-ar] Translated file : docs/source/ar/tasks_explained.md into Arabic huggingface#33074
 The Transformer model family [i18n-ar] Translated file : docs/source/ar/model_summary.md into Arabic huggingface#33047
 Summary of the tokenizers [i18n-ar] Translated file : docs/source/ar/tokenizer_summary.md into Arabic huggingface#33078
 Attention [i18n-ar] Translated file : docs/source/ar/attention.md into Arabic huggingface#33021
 Padding and truncation [i18n-ar] Translated file : docs/source/ar/pad_truncation.md into Arabic huggingface#33050
 BERTology [i18n-ar] Translated file : docs/source/ar/bertology.md into Arabic huggingface#33024
 Perplexity of fixed-length models [i18n-ar] Translated file : docs/source/ar/perplexity.md into Arabic huggingface#33063
 Pipelines for webserver inference [i18n-ar] Translated file : docs/source/ar/pipeline_webserver.md into Arabic huggingface#33066
 Model training anatomy [i18n-ar] Translated file : docs/source/ar/model_memory_anatomy.md into Arabic huggingface#33045
 Getting the most out of LLMs [i18n-ar] Translated file : docs/source/ar/llm_tutorial_optimization.md into Arabic huggingface#33043
stevhliu pushed a commit that referenced this pull request Oct 9, 2024
)

Add Translate docs into Arabic - section files CONCEPTUAL GUIDES
---------------------------------------------------------------------------------------
 Philosophy [i18n-ar] Translated file : docs/source/ar/philosophy.md into Arabic #33064
 Glossary [i18n-ar] Translated file : docs/source/ar/glossary.md into Arabic #33038
 What 🤗 Transformers can do [i18n-ar] Translated file : docs/source/ar/task_summary.md into Arabic #33073
 How 🤗 Transformers solve tasks [i18n-ar] Translated file : docs/source/ar/tasks_explained.md into Arabic #33074
 The Transformer model family [i18n-ar] Translated file : docs/source/ar/model_summary.md into Arabic #33047
 Summary of the tokenizers [i18n-ar] Translated file : docs/source/ar/tokenizer_summary.md into Arabic #33078
 Attention [i18n-ar] Translated file : docs/source/ar/attention.md into Arabic #33021
 Padding and truncation [i18n-ar] Translated file : docs/source/ar/pad_truncation.md into Arabic #33050
 BERTology [i18n-ar] Translated file : docs/source/ar/bertology.md into Arabic #33024
 Perplexity of fixed-length models [i18n-ar] Translated file : docs/source/ar/perplexity.md into Arabic #33063
 Pipelines for webserver inference [i18n-ar] Translated file : docs/source/ar/pipeline_webserver.md into Arabic #33066
 Model training anatomy [i18n-ar] Translated file : docs/source/ar/model_memory_anatomy.md into Arabic #33045
 Getting the most out of LLMs [i18n-ar] Translated file : docs/source/ar/llm_tutorial_optimization.md into Arabic #33043
BernardZach pushed a commit to BernardZach/transformers that referenced this pull request Dec 5, 2024
…gingface#33982)

Add Translate docs into Arabic - section files CONCEPTUAL GUIDES
---------------------------------------------------------------------------------------
 Philosophy [i18n-ar] Translated file : docs/source/ar/philosophy.md into Arabic huggingface#33064
 Glossary [i18n-ar] Translated file : docs/source/ar/glossary.md into Arabic huggingface#33038
 What 🤗 Transformers can do [i18n-ar] Translated file : docs/source/ar/task_summary.md into Arabic huggingface#33073
 How 🤗 Transformers solve tasks [i18n-ar] Translated file : docs/source/ar/tasks_explained.md into Arabic huggingface#33074
 The Transformer model family [i18n-ar] Translated file : docs/source/ar/model_summary.md into Arabic huggingface#33047
 Summary of the tokenizers [i18n-ar] Translated file : docs/source/ar/tokenizer_summary.md into Arabic huggingface#33078
 Attention [i18n-ar] Translated file : docs/source/ar/attention.md into Arabic huggingface#33021
 Padding and truncation [i18n-ar] Translated file : docs/source/ar/pad_truncation.md into Arabic huggingface#33050
 BERTology [i18n-ar] Translated file : docs/source/ar/bertology.md into Arabic huggingface#33024
 Perplexity of fixed-length models [i18n-ar] Translated file : docs/source/ar/perplexity.md into Arabic huggingface#33063
 Pipelines for webserver inference [i18n-ar] Translated file : docs/source/ar/pipeline_webserver.md into Arabic huggingface#33066
 Model training anatomy [i18n-ar] Translated file : docs/source/ar/model_memory_anatomy.md into Arabic huggingface#33045
 Getting the most out of LLMs [i18n-ar] Translated file : docs/source/ar/llm_tutorial_optimization.md into Arabic huggingface#33043
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.

4 participants