WIP chapter 2 by jowharshamshiri · Pull Request #71 · huggingface/course

jowharshamshiri · 2022-03-31T01:46:58Z

Translated the introduction to chapter 2. This is a first draft to just get in sync with other contributors and find our common tone in translation. Also created glossary.csv in the root of 'fa' folder to standardize translations of some commonly mistranslated words--this too is a first draft open to suggestions from other contributors.

Related to #49

lewtun

Thank you for this great PR! I've left a small comment about adding the table of contents and a glossary, but otherwise this is looking good 🚀

I'll ask the Persian community for a quick review :)

lewtun · 2022-04-01T17:21:27Z

@@ -0,0 +1,32 @@
+Transformer,ترنسفورمر


I've been talking about a glossary / vocabulary with the Italian translators in #45 and I think it would be nice to have this as a "chapter" that the Persian readers can access.

To enable that, you'll just need to add a new section to the _toctree.yml file like the following:

- title: Glossary # <= translate this to Farsi sections: - local: glossary/1 title: Glossary # Same here

lewtun · 2022-04-01T17:46:55Z

@@ -0,0 +1,20 @@
+#مقدمه


To render this on the website, we should add a _toctree.yml file with the following content:

- title: 1. Transformer models # Translate this sections: - local: chapter2/1 title: Introduction # And this

lewtun · 2022-04-01T17:46:55Z

@@ -0,0 +1,20 @@
+#مقدمه


To render this on the website, we should add a _toctree.yml file with the following content:

- title: 1. Transformer models # Translate this sections: - local: chapter2/1 title: Introduction # And this

lewtun · 2022-04-01T17:47:45Z

@@ -0,0 +1,353 @@
+<FrameworkSwitchCourse {fw} />


You should remove all the untranslated files - we only render on the website the chapters / sections that are translated

lewtun · 2022-04-01T17:47:46Z

@@ -0,0 +1,353 @@
+<FrameworkSwitchCourse {fw} />


You should remove all the untranslated files - we only render on the website the chapters / sections that are translated

MehranMirkhan

I am a native Persian speaker. The translations look good to me.

jowharshamshiri · 2022-04-03T22:32:55Z

@lewtun can we get this through I have another page incoming and need to add terms to the glossary but don't want to invalidate this review. :)

jowharshamshiri · 2022-04-04T00:34:10Z

I have chapter 0 ready for merge in a separate branch on my fork. Will submit in separate PR for review.

lewtun · 2022-04-01T17:21:27Z

@@ -0,0 +1,32 @@
+Transformer,ترنسفورمر


I've been talking about a glossary / vocabulary with the Italian translators in #45 and I think it would be nice to have this as a "chapter" that the Persian readers can access.

To enable that, you'll just need to add a new section to the _toctree.yml file like the following:

- title: Glossary # <= translate this to Farsi sections: - local: glossary/1 title: Glossary # Same here

I added a section for glossary, it is no longer a CSV file. This I think is resolved. Looks like this in _toctree.yml:

title: واژه‌نامه
sections:

local: glossary/1
title: واژه‌نامه

LGTM, thanks!

lewtun · 2022-04-04T13:32:00Z

@@ -0,0 +1,26 @@
+<div dir="rtl">
+<h1>مقدمه</h1>


I seem to be having some trouble building the docs because the tool we use assumes that we have a Markdown header like

# Chapter title

as the start of the file. Could you please try installing our doc-builder tool via:

pip install git+https://github.com/huggingface/doc-builder.git

Then try building the docs with:

doc-builder build course ../course/chapters/fa --build_dir tmp-docs --clean --not_python_module --html --language fa

You might need to experiment with the format of the header here - are there any guidelines on writing Farsi in Markdown?

Thanks for this. will do tonight. I am having so much trouble both with the characters and the RTL nature of the language. Finding editors is hard too. We might need to write that guide, haven't come across one myself.

lewtun · 2022-04-04T13:33:04Z

@@ -0,0 +1,52 @@
+| معادل در منبع         | معادل در ترجمه   |


Similarly, here we'll need a H1 header with something like

# Glossary <= translate this

lewtun · 2022-04-04T13:34:15Z

@lewtun can we get this through I have another page incoming and need to add terms to the glossary but don't want to invalidate this review. :)

Hey @jowharshamshiri happy to merge this once we can get the docs to build. I've left some suggestions on trying this yourself, but please let me know if you need some help!

jowharshamshiri · 2022-04-05T00:15:41Z

Hey @lewtun, I got the docs to build with a workaround--the first header is now unfortunately rendering in LTR mode. This is ok for now so we can move forward with translating other pages. I also experimented with DISABLE-FRONTMATTER-SECTIONS and even adding an empty code block but alas to no avail. I want to open an issue on doc-builder, whereby we add a 'direction' arg or otherwise automatically figure out the direction of languages. That info is then used to automatically handle the direction of the generated divs and whatnot. If we do that we can dispense with the extra RTL divs and spans everywhere in Persian and also other RTL-language docs. Is that something that sounds worthwhile to you or am I confused?

lewtun · 2022-04-05T10:20:58Z

Thanks a lot for diving into this @jowharshamshiri - I had no idea it would be so tricky 😬 .

I think opening an issue on doc-builder would make a lot of sense as I can already see we're running into the same issue with other RTL languages. I suggest providing a super simple example of an MDX file and corresponding _toctree.yml file that reproduces the problem and separately shows the hacks you've needed to implement to make it work.

In the meantime, I'll test I can build the current PR!

lewtun · 2022-04-05T10:22:52Z

      path_to_docs: course/chapters/
      additional_args: --not_python_module
-      languages: en es fr he pt ru th tr
+      languages: en es fa fr he pt ru th tr


FYI I've added Farsi to the list of languages here so we can build the docs in the CI

HuggingFaceDocBuilderDev · 2022-04-05T10:36:31Z

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

… main

jowharshamshiri · 2022-04-05T11:49:07Z

Hey @lewtun, while trying to file the issue and reproduce the problem I found a simpler workaround which I included in new commits. Please kindly merge. The first header now renders correctly as RTL. I filed an issue on doc-builder here to automate this.

P.S. I think maybe in the CI build you have the lang arg still set to en. It is building the original English docs.

lewtun · 2022-04-05T11:51:36Z

Thank you for finding a nice fix! Will merge this now 🤗

P.S. I think maybe in the CI build you have the lang arg still set to en. It is building the original English docs.

Yeah that's a current limitation with our UI - we need to add a dropdown button to view the PR in language X, hopefully will have that soon!

WIP chapter 2

jowharshamshiri added 2 commits March 31, 2022 06:01

Translated first page of chapter 2. Created glossary.csv

19f85ba

First draft of translation for chapter 2/page 1.

dc95f21

lewtun reviewed Apr 1, 2022

View reviewed changes

lewtun mentioned this pull request Apr 1, 2022

Translation to Persian #50

Open

69 tasks

I think I fixed issues raised in PR huggingface#71.

bf4be18

MehranMirkhan approved these changes Apr 3, 2022

View reviewed changes

jowharshamshiri added 6 commits April 3, 2022 23:32

Fixed the formatting. Added div and span tags for RTL and LTR sections.

2b588ac

Fixed formatting for a list.

b7e780f

Formatting, trying to get github to format RTL text and lists.

dd863b7

No dice, reverted to using basic HTML for now.

0044dbe

Added HTML box for the tip on the bottom of the page.

3b11c16

Github doesn't render box. I am done with this for now.

50ce545

lewtun reviewed Apr 4, 2022

View reviewed changes

Changed headers to be able to run doc-builder. Ugly, but ok for now.

1e6a447

lewtun added 2 commits April 5, 2022 12:21

Merge branch 'main' into jowharshamshiri/main

b8b6b60

Add Farsi to CI

7c07307

lewtun reviewed Apr 5, 2022

View reviewed changes

jowharshamshiri added 2 commits April 5, 2022 15:38

Better workaround found while reproducing bug for issue on doc-builder.

710cbcd

Merge branch 'main' of https://github.com/jowharshamshiri/course into…

f09fc80

… main

jowharshamshiri mentioned this pull request Apr 5, 2022

Support for rendering RTL languages huggingface/doc-builder#176

Open

lewtun merged commit 4c18fa5 into huggingface:main Apr 5, 2022

GITbaburin pushed a commit to GITbaburin/course that referenced this pull request May 17, 2026

I think I fixed issues raised in PR huggingface#71.

09cea36

GITbaburin pushed a commit to GITbaburin/course that referenced this pull request May 17, 2026

Merge pull request huggingface#71 from jowharshamshiri/main

d0da8ed

WIP chapter 2

		@@ -0,0 +1,52 @@
		\| معادل در منبع \| معادل در ترجمه \|

Uh oh!

Conversation

jowharshamshiri commented Mar 31, 2022 • edited by lewtun Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lewtun left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MehranMirkhan left a comment

Choose a reason for hiding this comment

Uh oh!

jowharshamshiri commented Apr 3, 2022

Uh oh!

jowharshamshiri commented Apr 4, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jowharshamshiri Apr 4, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lewtun commented Apr 4, 2022

Uh oh!

jowharshamshiri commented Apr 5, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lewtun commented Apr 5, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

HuggingFaceDocBuilderDev commented Apr 5, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jowharshamshiri commented Apr 5, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lewtun commented Apr 5, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jowharshamshiri commented Mar 31, 2022 •

edited by lewtun

Loading

jowharshamshiri Apr 4, 2022 •

edited

Loading

jowharshamshiri commented Apr 5, 2022 •

edited

Loading

HuggingFaceDocBuilderDev commented Apr 5, 2022 •

edited

Loading

jowharshamshiri commented Apr 5, 2022 •

edited

Loading