Duplicate from kknono668/toeic-vocab-tw

Co-authored-by: YANG SHIH WEI <kknono668@users.noreply.huggingface.co>

LICENSE

@@ -0,0 +1,16 @@
+Creative Commons Attribution 4.0 International (CC BY 4.0)
+
+This dataset is licensed under the Creative Commons Attribution 4.0 International License.
+
+You are free to:
+- Share — copy and redistribute the material in any medium or format
+- Adapt — remix, transform, and build upon the material for any purpose, even commercially.
+
+Under the following terms:
+- Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
+
+No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
+
+Full License Text:
+https://creativecommons.org/licenses/by/4.0/legalcode
+

README.md

@@ -0,0 +1,174 @@
+---
+pretty_name: 完整 TOEIC 單字庫 (English–Traditional Chinese)
+license: cc-by-4.0
+language:
+- en
+- zh
+language_bcp47:
+- zh-Hant
+configs:
+- config_name: default
+  data_files:
+  - data/toeic_vocabulary_view.json
+tags:
+- toeic
+- vocabulary
+- bilingual
+- english-chinese
+- traditional-chinese
+- business
+- education
+task_categories:
+- other
+size_categories:
+- 1K<n<10K
+---
+
+# 完整 TOEIC 單字庫（English–Traditional Chinese）
+
+一份面向 TOEIC 情境的雙語單字庫，涵蓋商務、辦公、會議、客戶服務、財務會計、行銷銷售、採購物流、法律合規、資訊技術等多個常見領域。資料以 JSON 提供，並依重要度劃分 5★–1★ 等級，附詞性、詞形變化與中英雙語例句，便於教學、備考、應用開發與語言學習研究。
+
+## Dataset Summary
+
+- Title: 完整 TOEIC 單字庫
+- Version: 110.5
+- Total Words: 9,537
+- Language Pair: English ↔ Traditional Chinese (繁體中文)
+- Structure: 單一 JSON 陣列（每列一個詞條）+ `data/metadata.json`
+
+## Files
+
+- `data/toeic_vocabulary.json`：主資料檔（頂層為陣列，每列一個詞條）
+- `data/metadata.json`：資料集中繼資料（title/version/last_updated/total_words…）
+  
+可選（仍為 JSON，便於 Viewer 預覽）：
+- `data/toeic_vocabulary_view.json`：Viewer 友善版（巢狀欄位以字串存放，如 `word_forms_json`、`examples_json`，方便 HF 轉成表格）
+
+## Schema
+
+- 主檔（`data/toeic_vocabulary.json`）為「頂層陣列」，每個詞條包含：
+
+- `english_word`：英文單字
+- `chinese_definition`：中文定義
+- `star_rating`：整數（1–5）
+- `category`：所屬主題分類
+- `parts_of_speech`：詞性陣列（如 noun/verb/adj/adv 等）
+- `word_forms`：依詞性細分的詞形（例：名詞複數、動詞三單/過去式/分詞/動名詞等）
+- `examples`：例句陣列（`english`、`chinese`）
+- `importance_group`：原始分組標籤（如 `5_stars_essential`）
+
+- 中繼資料（`data/metadata.json`）：
+  - `title`、`version`、`description`、`total_words`、`creation_date`、`language_pair`
+  - `categories`、`star_system`、`last_updated`
+
+### Star System 說明
+
+- 5★ 核心商業詞彙：最高優先級，TOEIC 必備
+- 4★ 重要專業詞彙：商務場合常用
+- 3★ 職場/學術詞彙：有助提升語言能力
+- 2★ 有用支援詞彙：擴展詞彙量
+- 1★ 一般詞彙：建議了解
+
+## Example Instance
+
+```json
+{
+  "english_word": "answer",
+  "chinese_definition": "回覆；答覆；回應",
+  "star_rating": 5,
+  "category": "溝通互動",
+  "parts_of_speech": ["noun", "verb"],
+  "word_forms": {
+    "noun": {"plural": "answers"},
+    "verb": {
+      "third_person_sg": "answers",
+      "past": "answered",
+      "past_participle": "answered",
+      "present_participle": "answering"
+    }
+  },
+  "examples": [
+    {"english": "Could you please answer the questionnaire before the meeting?", "chinese": "請在會議前填寫問卷並回覆。"},
+    {"english": "The applicant needs to answer all the questions truthfully.", "chinese": "申請人需要誠實地回答所有問題。"}
+  ],
+  "importance_group": "5_stars_essential"
+}
+```
+
+## Usage
+
+### Local (JSON)
+
+```python
+import json
+from pathlib import Path
+
+path = Path("data/toeic_vocabulary.json")
+rows = json.loads(path.read_text(encoding="utf-8"))  # 頂層為陣列
+
+print(len(rows), "words total")
+# 篩選 5★ 詞條
+top_words = [r for r in rows if r.get("importance_group") == "5_stars_essential"]
+print(len(top_words), "top words")
+print(top_words[0]["english_word"], top_words[0]["chinese_definition"])
+```
+
+### After Upload (datasets)
+
+上傳到 Hugging Face 後，可使用 `datasets` 套件讀取：
+
+```python
+from datasets import load_dataset
+
+# 直接載入主檔（頂層陣列 JSON；保留巢狀欄位）
+ds = load_dataset(
+    "json",
+    data_files="https://huggingface.co/datasets/kknono668/toeic-vocab-tw/resolve/main/data/toeic_vocabulary.json",
+    split="train",
+)
+
+# 若要簡化成純表格欄位，可改載入 viewer 友善版（巢狀欄位已字串化）
+# ds = load_dataset(
+#   "json",
+#   data_files="https://huggingface.co/datasets/kknono668/toeic-vocab-tw/resolve/main/data/toeic_vocabulary_view.json",
+#   split="train",
+# )
+```
+
+> 提示：若要轉為扁平表格（如 Pandas DataFrame），可將各重要度群組展開並加上 `importance_group` 欄位。
+
+## Intended Uses
+
+- TOEIC 應試準備、語言教學與練習
+- 商務英語學習應用（查詢、測驗、卡片、練習題生成）
+- 詞彙表與例句檢索工具
+
+## Limitations
+
+- 定義與例句聚焦於職場/商務情境，對一般語境未必全面
+- 詞性與詞形為常見用法彙整，未涵蓋所有罕見變化
+
+## License
+
+本資料集以 CC BY 4.0 釋出。請在使用時適當標註來源與作者，並附上授權連結。
+
+- Name: Creative Commons Attribution 4.0 International (CC BY 4.0)
+- Link: https://creativecommons.org/licenses/by/4.0/
+
+## Citation
+
+如果你在研究或產品中使用了本資料集，請引用：
+
+```
+@misc{toeic_vocab_2025,
+  title  = {完整 TOEIC 單字庫 (English–Traditional Chinese)},
+  year   = {2025},
+  note   = {CC BY 4.0},
+  howpublished = {Hugging Face Dataset}
+}
+```
+
+## Changelog
+
+- v34.8: 初版公開；9,855 詞條；依 5★–1★ 分組；含詞性、詞形、例句與分類。
+

scripts/flatten_toeic.py

@@ -0,0 +1,54 @@
+import json
+import csv
+from pathlib import Path
+
+SRC = Path("data/toeic_vocabulary.json")
+OUT_JSONL = Path("data/toeic_vocabulary_flat.jsonl")
+OUT_CSV = Path("data/toeic_vocabulary_flat.csv")
+
+def main():
+    data = json.loads(SRC.read_text(encoding="utf-8"))
+    vocab_groups = data.get("vocabulary_by_importance", {})
+
+    rows = []
+    for importance_group, items in vocab_groups.items():
+        if not isinstance(items, list):
+            continue
+        for item in items:
+            row = {
+                "importance_group": importance_group,
+                "english_word": item.get("english_word"),
+                "chinese_definition": item.get("chinese_definition"),
+                "star_rating": item.get("star_rating"),
+                "category": item.get("category"),
+                "parts_of_speech": "|".join(item.get("parts_of_speech", []) or []),
+                "word_forms": json.dumps(item.get("word_forms", {}), ensure_ascii=False),
+                "examples": json.dumps(item.get("examples", []), ensure_ascii=False),
+            }
+            rows.append(row)
+
+    # write jsonl
+    with OUT_JSONL.open("w", encoding="utf-8", newline="\n") as f:
+        for r in rows:
+            f.write(json.dumps(r, ensure_ascii=False) + "\n")
+
+    # write csv
+    cols = [
+        "importance_group",
+        "english_word",
+        "chinese_definition",
+        "star_rating",
+        "category",
+        "parts_of_speech",
+        "word_forms",
+        "examples",
+    ]
+    with OUT_CSV.open("w", encoding="utf-8", newline="") as f:
+        writer = csv.DictWriter(f, fieldnames=cols)
+        writer.writeheader()
+        for r in rows:
+            writer.writerow(r)
+
+if __name__ == "__main__":
+    main()
+

scripts/make_viewer_json.ps1

@@ -0,0 +1,51 @@
+Param()
+
+$ErrorActionPreference = 'Stop'
+
+$root = Split-Path $PSScriptRoot -Parent
+$src = Join-Path $root 'data' 'toeic_vocabulary.json'
+$dst = Join-Path $root 'data' 'toeic_vocabulary_view.json'
+
+if (!(Test-Path $src)) { throw "找不到資料檔：$src" }
+
+$obj = Get-Content -Path $src -Raw -Encoding UTF8 | ConvertFrom-Json
+
+# 支援兩種結構：
+# 1) 頂層陣列（新結構）
+# 2) 含 vocabulary_by_importance（舊結構）
+
+$items = @()
+if ($obj -is [System.Array]) {
+  $items = $obj
+} else {
+  $groups = $obj.vocabulary_by_importance.PSObject.Properties
+  foreach ($prop in $groups) {
+    $importance = $prop.Name
+    foreach ($it in $prop.Value) {
+      # 注入 importance_group 以統一欄位
+      $it | Add-Member -NotePropertyName importance_group -NotePropertyValue $importance -Force
+      $items += $it
+    }
+  }
+}
+
+$out = @()
+foreach ($r in $items) {
+  # 保持欄位型別簡單：純字串、整數
+  $pos = $r.parts_of_speech
+  if ($null -eq $pos) { $pos = @() }
+  if ($pos -isnot [System.Array]) { $pos = @($pos) }
+  $out += [pscustomobject]@{
+    english_word       = [string]$r.english_word
+    chinese_definition = [string]$r.chinese_definition
+    star_rating        = [int]$r.star_rating
+    category           = [string]$r.category
+    parts_of_speech    = ($pos -join '|')
+    word_forms_json    = if ($r.word_forms) { ($r.word_forms | ConvertTo-Json -Depth 20 -Compress) } else { $null }
+    examples_json      = if ($r.examples) { ($r.examples | ConvertTo-Json -Depth 20 -Compress) } else { $null }
+    importance_group   = [string]$r.importance_group
+  }
+}
+
+$out | ConvertTo-Json -Depth 5 | Set-Content -Path $dst -Encoding UTF8
+Write-Host "已輸出 Viewer 友善 JSON -> $dst" -ForegroundColor Green

scripts/release.ps1

@@ -0,0 +1,38 @@
+Param(
+  [string]$Version,
+  [string]$Message = "Release"
+)
+
+$ErrorActionPreference = 'Stop'
+
+$root = Split-Path $PSScriptRoot -Parent
+Set-Location $root
+
+Write-Host "[1/4] 更新 metadata (version=$Version)" -ForegroundColor Cyan
+& (Join-Path $PSScriptRoot 'update_metadata.ps1') -Version $Version
+
+# 讀取更新後的總詞數與版本（兼容兩種結構）
+$dataPath = Join-Path $root 'data' 'toeic_vocabulary.json'
+$obj = Get-Content -Path $dataPath -Raw -Encoding UTF8 | ConvertFrom-Json
+if ($obj -is [System.Array]) {
+  $total = @($obj).Count
+  $metaPath = Join-Path $root 'data' 'metadata.json'
+  $meta = if (Test-Path $metaPath) { Get-Content -Path $metaPath -Raw -Encoding UTF8 | ConvertFrom-Json } else { $null }
+  $v = if ($meta) { $meta.version } else { $Version }
+} else {
+  $total = [int]$obj.metadata.total_words
+  $v = $obj.metadata.version
+}
+
+Write-Host "[2/4] 產生 Viewer 友善 JSON" -ForegroundColor Cyan
+& (Join-Path $PSScriptRoot 'make_viewer_json.ps1')
+
+Write-Host "[3/4] 更新 README 統計" -ForegroundColor Cyan
+& (Join-Path $PSScriptRoot 'update_readme.ps1') -Version $v -TotalWords $total
+
+Write-Host "[4/4] 提交並推送" -ForegroundColor Cyan
+git add README.md data/toeic_vocabulary.json data/metadata.json data/toeic_vocabulary_view.json scripts/*.ps1 | Out-Null
+$commitMsg = if ($Version) { "${Message} v${v}" } else { $Message }
+git commit -m $commitMsg | Out-Null
+git push -u origin main
+Write-Host "完成發佈：$commitMsg" -ForegroundColor Green

scripts/update_metadata.ps1

@@ -0,0 +1,42 @@
+Param(
+  [string]$Version
+)
+
+$ErrorActionPreference = 'Stop'
+
+$root = Split-Path $PSScriptRoot -Parent
+$jsonPath = Join-Path $root 'data' 'toeic_vocabulary.json'
+if (!(Test-Path $jsonPath)) { throw "找不到資料檔：$jsonPath" }
+
+$data = Get-Content -Path $jsonPath -Raw -Encoding UTF8 | ConvertFrom-Json
+
+if ($data -is [System.Array]) {
+  # 新結構：頂層陣列，metadata 存在 data/metadata.json
+  $total = @($data).Count
+  $metaPath = Join-Path $root 'data' 'metadata.json'
+  if (Test-Path $metaPath) {
+    $meta = Get-Content -Path $metaPath -Raw -Encoding UTF8 | ConvertFrom-Json
+  } else {
+    $meta = [ordered]@{}
+  }
+  $meta.total_words = $total
+  $meta.last_updated = (Get-Date).ToString('o')
+  if ($Version) { $meta.version = $Version }
+  ($meta | ConvertTo-Json -Depth 100) | Set-Content -Path $metaPath -Encoding UTF8
+  Write-Host "已更新 metadata.json：total_words=$total; version=$($meta.version); last_updated=$($meta.last_updated)"
+} else {
+  # 舊結構：含 metadata 與 vocabulary_by_importance
+  $total = 0
+  foreach ($prop in $data.vocabulary_by_importance.PSObject.Properties) {
+    $items = $prop.Value
+    if ($items -is [System.Collections.IEnumerable]) {
+      $total += @($items).Count
+    }
+  }
+  $data.metadata.total_words = $total
+  $data.metadata.last_updated = (Get-Date).ToString('o')
+  if ($Version) { $data.metadata.version = $Version }
+  $jsonOut = $data | ConvertTo-Json -Depth 100
+  Set-Content -Path $jsonPath -Value $jsonOut -Encoding UTF8
+  Write-Host "已更新 metadata：total_words=$total; version=$($data.metadata.version); last_updated=$($data.metadata.last_updated)"
+}

scripts/update_readme.ps1

@@ -0,0 +1,22 @@
+Param(
+  [Parameter(Mandatory=$true)][string]$Version,
+  [Parameter(Mandatory=$true)][int]$TotalWords
+)
+
+$ErrorActionPreference = 'Stop'
+
+$readme = Join-Path $PSScriptRoot '..' 'README.md'
+if (!(Test-Path $readme)) { throw "找不到 README：$readme" }
+
+$content = Get-Content -Path $readme -Raw -Encoding UTF8
+
+# 版本
+$content = [regex]::Replace($content, "(?m)^-\s*Version:\s*.*$", "- Version: $Version")
+
+# 總詞數（加上千位逗號）
+$totalFmt = ([string]::Format([System.Globalization.CultureInfo]::InvariantCulture, "{0:N0}", $TotalWords))
+$content = [regex]::Replace($content, "(?m)^-\s*Total Words:\s*.*$", "- Total Words: $totalFmt")
+
+Set-Content -Path $readme -Value $content -Encoding UTF8
+Write-Host "已更新 README：Version=$Version, Total Words=$totalFmt"
+