huggingface / huggingface/course

Add Traditional Chinese (zh-TW) Jupyter notebooks for HF Course — Full Coverage (Chapters 1–11)

Open
#1,232 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
MDX
Stars
4.2k
Forks
1.4k
Avg merge
13m
Merged PRs (30d)
1

Description

## Summary

The [Hugging Face NLP Course](https://huggingface.co/course/) has a Traditional Chinese (zh-TW) translation at [`huggingface/course`](https://github.com/huggingface/course) covering Chapters 0–9. The course MDX files embed "Open in Colab" and "Open in AWS Studio" badges that link to language-specific notebooks under `course//`.

**Goal:** Create zh-TW versions of all **60 notebooks** in the English canonical source, translating directly from English to Traditional Chinese across Chapters 1–11.

**Current state:**
- PR [#625](https://github.com/huggingface/notebooks/pull/625) (open) adds the first 2 zh-TW notebooks for Chapter 1.
- Chapters 1–6 zh-TW MDX files currently link to `course/zh-CN/` paths — these must also be updated in [`huggingface/course`](https://github.com/huggingface/course) to point to the new `course/zh-TW/` paths once notebooks are created.
- Chapters 7–9 zh-TW MDX files link to language-neutral `course/chapter*/` paths — these must similarly be updated.
- Chapters 10–11 zh-TW MDX translation does not yet exist.

This issue tracks all notebook work across three phases. All notebooks are translated from the English source (`course/en/`).

---

## Scope

| Phase | Chapters | Notebooks | Prerequisite |
|-------|----------|-----------|--------------|
| **1** (immediate) | 1–6 | 31 total (29 remaining) | Also update zh-TW MDX links in `huggingface/course` |
| **2** (future) | 7–9 | 23 | Also update zh-TW MDX links in `huggingface/course` |
| **3** (future) | 10–11 | 6 | zh-TW MDX translation first |
| **Total** | | **60** | |

---

## Phase 1 — Chapters 1–6 (immediate)

**Source:** copy the corresponding `course/en/` notebook → `course/zh-TW/`, translate all Markdown cells to Traditional Chinese.

**Companion PR needed:** after notebooks merge, open a PR in [`huggingface/course`](https://github.com/huggingface/course) to update the `notebooks={…}` URLs in the zh-TW MDX files from `zh-CN` paths to the new `zh-TW` paths.

### Chapter 1 — Transformer Models (2 notebooks)

- [x] `course/zh-TW/chapter1/section3.ipynb` — ✅ PR #625
- [x] `course/zh-TW/chapter1/section8.ipynb` — ✅ PR #625

### Chapter 2 — Using 🤗 Transformers (5 notebooks)

- [ ] `course/zh-TW/chapter2/section2_pt.ipynb` (source: `course/en/chapter2/section2_pt.ipynb`)
- [ ] `course/zh-TW/chapter2/section3_pt.ipynb` (source: `course/en/chapter2/section3_pt.ipynb`)
- [ ] `course/zh-TW/chapter2/section4_pt.ipynb` (source: `course/en/chapter2/section4_pt.ipynb`)
- [ ] `course/zh-TW/chapter2/section5_pt.ipynb` (source: `course/en/chapter2/section5_pt.ipynb`)
- [ ] `course/zh-TW/chapter2/section6_pt.ipynb` (source: `course/en/chapter2/section6_pt.ipynb`)

### Chapter 3 — Fine-tuning a Pretrained Model (4 notebooks)

- [ ] `course/zh-TW/chapter3/section2.ipynb` (source: `course/en/chapter3/section2.ipynb`)
- [ ] `course/zh-TW/chapter3/section3.ipynb` (source: `course/en/chapter3/section3.ipynb`)
- [ ] `course/zh-TW/chapter3/section4.ipynb` (source: `course/en/chapter3/section4.ipynb`)
- [ ] `course/zh-TW/chapter3/section7.ipynb` (source: `course/en/chapter3/section7.ipynb`)

### Chapter 4 — Sharing Models and Tokenizers (4 notebooks)

- [ ] `course/zh-TW/chapter4/section2_pt.ipynb` (source: `course/en/chapter4/section2_pt.ipynb`)
- [ ] `course/zh-TW/chapter4/section2_tf.ipynb` (source: `course/en/chapter4/section2_tf.ipynb`)
- [ ] `course/zh-TW/chapter4/section3_pt.ipynb` (source: `course/en/chapter4/section3_pt.ipynb`)
- [ ] `course/zh-TW/chapter4/section3_tf.ipynb` (source: `course/en/chapter4/section3_tf.ipynb`)

### Chapter 5 — 🤗 Datasets Library (6 notebooks)

- [ ] `course/zh-TW/chapter5/section2.ipynb` (source: `course/en/chapter5/section2.ipynb`)
- [ ] `course/zh-TW/chapter5/section3.ipynb` (source: `course/en/chapter5/section3.ipynb`)
- [ ] `course/zh-TW/chapter5/section4.ipynb` (source: `course/en/chapter5/section4.ipynb`)
- [ ] `course/zh-TW/chapter5/section5.ipynb` (source: `course/en/chapter5/section5.ipynb`)
- [ ] `course/zh-TW/chapter5/section6_pt.ipynb` (source: `course/en/chapter5/section6_pt.ipynb`)
- [ ] `course/zh-TW/chapter5/section6_tf.ipynb` (source: `course/en/chapter5/section6_tf.ipynb`)

### Chapter 6 — 🤗 Tokenizers Library (10 notebooks)

- [ ] `course/zh-TW/chapter6/section2.ipynb` (source: `course/en/chapter6/section2.ipynb`)
- [ ] `course/zh-TW/chapter6/section3_pt.ipynb` (source: `course/en/chapter6/section3_pt.ipynb`)
- [ ] `course/zh-TW/chapter6/section3_tf.ipynb` (source: `course/en/chapter6/section3_tf.ipynb`)
- [ ] `course/zh-TW/chapter6/section3b_pt.ipynb` (source: `course/en/chapter6/section3b_pt.ipynb`)
- [ ] `course/zh-TW/chapter6/section3b_tf.ipynb` (source: `course/en/chapter6/section3b_tf.ipynb`)
- [ ] `course/zh-TW/chapter6/section4.ipynb` (source: `course/en/chapter6/section4.ipynb`)
- [ ] `course/zh-TW/chapter6/section5.ipynb` (source: `course/en/chapter6/section5.ipynb`)
- [ ] `course/zh-TW/chapter6/section6.ipynb` (source: `course/en/chapter6/section6.ipynb`)
- [ ] `course/zh-TW/chapter6/section7.ipynb` (source: `course/en/chapter6/section7.ipynb`)
- [ ] `course/zh-TW/chapter6/section8.ipynb` (source: `course/en/chapter6/section8.ipynb`)

---

## Phase 2 — Chapters 7–9 (future)

**Source:** copy the corresponding `course/en/` notebook → `course/zh-TW/`, translate all Markdown cells to Traditional Chinese.

**Companion PR needed:** after notebooks merge, open a PR in [`huggingface/course`](https://github.com/huggingface/course) to update the `notebooks={…}` URLs in the zh-TW MDX files from language-neutral paths to the new `course/zh-TW/` paths.

### Chapter 7 — Main NLP Tasks (12 notebooks)

- [ ] `course/zh-TW/chapter7/section2_pt.ipynb` (source: `course/en/chapter7/section2_pt.ipynb`)
- [ ] `course/zh-TW/chapter7/section2_tf.ipynb` (source: `course/en/chapter7/section2_tf.ipynb`)
- [ ] `course/zh-TW/chapter7/section3_pt.ipynb` (source: `course/en/chapter7/section3_pt.ipynb`)
- [ ] `course/zh-TW/chapter7/section3_tf.ipynb` (source: `course/en/chapter7/section3_tf.ipynb`)
- [ ] `course/zh-TW/chapter7/section4_pt.ipynb` (source: `course/en/chapter7/section4_pt.ipynb`)
- [ ] `course/zh-TW/chapter7/section4_tf.ipynb` (source: `course/en/chapter7/section4_tf.ipynb`)
- [ ] `course/zh-TW/chapter7/section5_pt.ipynb` (source: `course/en/chapter7/section5_pt.ipynb`)
- [ ] `course/zh-TW/chapter7/section5_tf.ipynb` (source: `course/en/chapter7/section5_tf.ipynb`)
- [ ] `course/zh-TW/chapter7/section6_pt.ipynb` (source: `course/en/chapter7/section6_pt.ipynb`)
- [ ] `course/zh-TW/chapter7/section6_tf.ipynb` (source: `course/en/chapter7/section6_tf.ipynb`)
- [ ] `course/zh-TW/chapter7/section7_pt.ipynb` (source: `course/en/chapter7/section7_pt.ipynb`)
- [ ] `course/zh-TW/chapter7/section7_tf.ipynb` (source: `course/en/chapter7/section7_tf.ipynb`)

### Chapter 8 — How to Ask for Help (5 notebooks)

- [ ] `course/zh-TW/chapter8/section2.ipynb` (source: `course/en/chapter8/section2.ipynb`)
- [ ] `course/zh-TW/chapter8/section3.ipynb` (source: `course/en/chapter8/section3.ipynb`)
- [ ] `course/zh-TW/chapter8/section4.ipynb` (source: `course/en/chapter8/section4.ipynb`)
- [ ] `course/zh-TW/chapter8/section4_tf.ipynb` (source: `course/en/chapter8/section4_tf.ipynb`)
- [ ] `course/zh-TW/chapter8/section5.ipynb` (source: `course/en/chapter8/section5.ipynb`)

### Chapter 9 — Building and Sharing Your Model (6 notebooks)

- [ ] `course/zh-TW/chapter9/section2.ipynb` (source: `course/en/chapter9/section2.ipynb`)
- [ ] `course/zh-TW/chapter9/section3.ipynb` (source: `course/en/chapter9/section3.ipynb`)
- [ ] `course/zh-TW/chapter9/section4.ipynb` (source: `course/en/chapter9/section4.ipynb`)
- [ ] `course/zh-TW/chapter9/section5.ipynb` (source: `course/en/chapter9/section5.ipynb`)
- [ ] `course/zh-TW/chapter9/section6.ipynb` (source: `course/en/chapter9/section6.ipynb`)
- [ ] `course/zh-TW/chapter9/section7.ipynb` (source: `course/en/chapter9/section7.ipynb`)

---

## Phase 3 — Chapters 10–11 (future: requires MDX translation first)

zh-TW MDX files for Chapters 10–11 do not yet exist. Notebooks can only be added after the course MDX is translated in [`huggingface/course`](https://github.com/huggingface/course).

**Source:** copy the corresponding `course/en/` notebook → `course/zh-TW/`, translate all Markdown cells to Traditional Chinese.

### Chapter 10 (3 notebooks)

- [ ] `course/zh-TW/chapter10/section2.ipynb` (source: `course/en/chapter10/section2.ipynb`)
- [ ] `course/zh-TW/chapter10/section3.ipynb` (source: `course/en/chapter10/section3.ipynb`)
- [ ] `course/zh-TW/chapter10/section5.ipynb` (source: `course/en/chapter10/section5.ipynb`)

### Chapter 11 (3 notebooks)

- [ ] `course/zh-TW/chapter11/section2.ipynb` (source: `course/en/chapter11/section2.ipynb`)
- [ ] `course/zh-TW/chapter11/section3.ipynb` (source: `course/en/chapter11/section3.ipynb`)
- [ ] `course/zh-TW/chapter11/section4.ipynb` (source: `course/en/chapter11/section4.ipynb`)

---

## Background — how notebook links work in the course

Each interactive section embeds a `` component:

```mdx

```

Until the zh-TW notebooks exist, Phase 1 links 404 and Phase 2 links point to the wrong language.

---

## Translation guidelines

- **Markdown cells:** translate from English to Traditional Chinese.
- **Code cells and output cells:** no changes needed.
- **Terminology reference:** the zh-TW MDX source files in [`chapters/zh-TW/`](https://github.com/huggingface/course/tree/main/chapters/zh-TW) are the authoritative terminology reference.
- Key vocabulary (EN → Traditional Chinese):
- dataset → 資料集
- training → 訓練
- fine-tuning → 微調
- tokenizer → 標記器
- pipeline → 管道
- model → 模型
- embedding → 嵌入

---

## Related

- PR [huggingface/notebooks#625](https://github.com/huggingface/notebooks/pull/625) — adds chapter 1 zh-TW notebooks (open, Phase 1)
- Course zh-TW translation PR [huggingface/course#1227](https://github.com/huggingface/course/pull/1227) — chapter 1 MDX files (open)

---

## How to contribute

1. Pick one or more unchecked notebooks from **Phase 1 or 2**. Phase 3 is blocked until the zh-TW MDX for Chapters 10–11 is translated in [`huggingface/course`](https://github.com/huggingface/course) first.
2. Copy `course/en/` → `course/zh-TW/`.
3. Translate all Markdown cells from English to Traditional Chinese. Code and output cells are unchanged.
4. Open a PR targeting `main`. Batching multiple notebooks from the same chapter in one PR is encouraged (see PR #625 as a model).
5. After the notebook PR merges, open a follow-up PR in [`huggingface/course`](https://github.com/huggingface/course) to update the `notebooks={…}` URLs in the zh-TW MDX files to point to the new `course/zh-TW/` paths.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.