Skip to content

Doc translate to Persian(farsi) #45664

Open
zeoses wants to merge 3 commits intohuggingface:mainfrom
zeoses:doc-translate-to-farsi
Open

Doc translate to Persian(farsi) #45664
zeoses wants to merge 3 commits intohuggingface:mainfrom
zeoses:doc-translate-to-farsi

Conversation

@zeoses
Copy link
Copy Markdown

@zeoses zeoses commented Apr 27, 2026

This PR adds a new README_fa.md file to begin providing Persian-language documentation for the project.

The goal is to improve multilingual accessibility and offer native-language support for Persian-speaking users.

This is a documentation-only contribution and does not modify any source code.

What does this PR do?
Adds a dedicated Persian README (README_fa.md)
Improves multilingual support and documentation accessibility
There is no related issue; this is a standalone documentation improvement.

Fixes: N/A

Code Agent Policy
[x] I confirm that this is not a pure code agent PR.I drafted the file manually and used an assistant only for wording review.

Before submitting
[x] This PR improves the documentation.
[x] I have read the contributor guidelines (Pull Request section).
[x] This change does not require discussion via an issue or forum.
[x] I have updated the documentation by adding the new Persian README.
[ ] No tests are required for this documentation-only PR.

Who can review?
This PR only affects documentation.

Reviewers familiar with documentation guidelines may review it.

Suggested reviewer: @stevhliu

zeoses added 2 commits April 28, 2026 00:22
 Add README_fa.md to introduce Persian documentation support

This commit adds a Persian version of the README (README_fa.md) to improve multilingual support and make the project more accessible for Persian-speaking users.
add farsi translation for README.md
Copy link
Copy Markdown
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.

thanks for the translation

make sure the structure and content stays consistent with the English source. it seems like some details are missing

Comment thread i18n/README_fa.md
پایپ لاین (Pipeline) یک کلاس سطح‌بالا برای انجام استنتاج (Inference) است که از کار با متن، صدا، تصویر و وظایف چندوجهی (multimodal) پشتیبانی می‌کند. این ابزار به‌طور خودکار مراحل پیش‌پردازش ورودی را انجام می‌دهد و خروجی مناسب را برمی‌گرداند.

برای شروع، یک pipeline بسازید و مشخص کنید از چه مدلی برای تولید متن استفاده شود. مدل به‌صورت خودکار دانلود و در حافظهٔ کش (cache) ذخیره می‌شود تا در اجراهای بعدی بتوان به‌راحتی دوباره از آن استفاده کرد.
### تولید متن (Text Generation)
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.

Suggested change
### تولید متن (Text Generation)

Comment thread i18n/README_fa.md
[{'generated_text': 'the secret to baking a really good cake is 1) to use the right ingredients and 2) to follow the recipe exactly. the recipe for the cake is as follows: 1 cup of sugar, 1 cup of flour, 1 cup of milk, 1 cup of butter, 1 cup of eggs, 1 cup of chocolate chips. if you want to make 2 cakes, how much sugar do you need? To make 2 cakes, you will need 2 cups of sugar.'}]
```

### چت (Chat)
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.

missing a > [!TIP] about chatting with a model directly from the command line and the corresponding code snippet

Suggested change
### چت (Chat)

Comment thread i18n/README_fa.md

*نکته: همچنین می‌توانید از رابط خط فرمان `transformers chat` برای چت در ترمینال استفاده کنید.*

### سایر مدالیته‌ها (صدا، بینایی کامپیوتر، چندوجهی)
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.

use <details>/<summary> blocks to hide the asr, image classification, and vqa examples

Comment thread i18n/README_fa.md

## چرا باید از Transformers استفاده کنیم؟

۱. **استفاده آسان:** دسترسی به پیشرفته‌ترین مدل‌ها با کمترین مانع، انتزاع (abstraction) کم و یک API یکپارچه.
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.

each of these have some sub-bullets that appear to be missing

Comment thread i18n/README_fa.md
* رابط آموزش (Training API) بهینه‌سازی شده برای مدل‌های Transformers است. برای حلقه‌های عمومی یادگیری ماشین، بهتر است از کتابخانه‌هایی مانند [Accelerate](Accelerate) استفاده کنید.
* [اسکریپت‌های نمونه](https://github.com/huggingface/transformers/tree/main/examples) ممکن است برای موارد استفاده خاص شما نیاز به تغییر و سازگاری داشته باشند.

## جامعه کاربری (Community)
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.

this section also seems heavily cut

Comment thread i18n/README_fa.md
## چرا *نباید* از Transformers استفاده کنیم؟

* این کتابخانه یک جعبه‌ابزار ماژولار برای شبکه‌های عصبی عمومی نیست؛ کدهای مدل‌ها عمداً برای محققان کمتر انتزاعی شده‌اند.
* رابط آموزش (Training API) بهینه‌سازی شده برای مدل‌های Transformers است. برای حلقه‌های عمومی یادگیری ماشین، بهتر است از کتابخانه‌هایی مانند [Accelerate](Accelerate) استفاده کنید.
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.

Suggested change
* رابط آموزش (Training API) بهینه‌سازی شده برای مدل‌های Transformers است. برای حلقه‌های عمومی یادگیری ماشین، بهتر است از کتابخانه‌هایی مانند [Accelerate](Accelerate) استفاده کنید.
* رابط آموزش (Training API) بهینه‌سازی شده برای مدل‌های Transformers است. برای حلقه‌های عمومی یادگیری ماشین، بهتر است از کتابخانه‌هایی مانند [Accelerate](https://huggingface.co/docs/accelerate) استفاده کنید.

Comment thread i18n/README_fa.md

تأثیر این کتابخانه بر جامعه کاربری بسیار گسترده است. صفحه [awesome-transformers](https://github.com/huggingface/transformers/blob/main/awesome-transformers.md) لیستی از ۱۰۰ پروژه فوق‌العاده را که با استفاده از Transformers ساخته شده‌اند، به نمایش می‌گذارد.

## مدل‌های نمونه
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.

missing many models in this section

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.

2 participants