lakjsndflkjaj commited on
Commit
3688fa2
·
0 Parent(s):

Dataset + kanana/qwen3 embeddings

Browse files
.gitattributes ADDED
@@ -0,0 +1,60 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ *.7z filter=lfs diff=lfs merge=lfs -text
2
+ *.arrow filter=lfs diff=lfs merge=lfs -text
3
+ *.avro filter=lfs diff=lfs merge=lfs -text
4
+ *.bin filter=lfs diff=lfs merge=lfs -text
5
+ *.bz2 filter=lfs diff=lfs merge=lfs -text
6
+ *.ckpt filter=lfs diff=lfs merge=lfs -text
7
+ *.ftz filter=lfs diff=lfs merge=lfs -text
8
+ *.gz filter=lfs diff=lfs merge=lfs -text
9
+ *.h5 filter=lfs diff=lfs merge=lfs -text
10
+ *.joblib filter=lfs diff=lfs merge=lfs -text
11
+ *.lfs.* filter=lfs diff=lfs merge=lfs -text
12
+ *.lz4 filter=lfs diff=lfs merge=lfs -text
13
+ *.mds filter=lfs diff=lfs merge=lfs -text
14
+ *.mlmodel filter=lfs diff=lfs merge=lfs -text
15
+ *.model filter=lfs diff=lfs merge=lfs -text
16
+ *.msgpack filter=lfs diff=lfs merge=lfs -text
17
+ *.npy filter=lfs diff=lfs merge=lfs -text
18
+ *.npz filter=lfs diff=lfs merge=lfs -text
19
+ *.onnx filter=lfs diff=lfs merge=lfs -text
20
+ *.ot filter=lfs diff=lfs merge=lfs -text
21
+ *.parquet filter=lfs diff=lfs merge=lfs -text
22
+ *.pb filter=lfs diff=lfs merge=lfs -text
23
+ *.pickle filter=lfs diff=lfs merge=lfs -text
24
+ *.pkl filter=lfs diff=lfs merge=lfs -text
25
+ *.pt filter=lfs diff=lfs merge=lfs -text
26
+ *.pth filter=lfs diff=lfs merge=lfs -text
27
+ *.rar filter=lfs diff=lfs merge=lfs -text
28
+ *.safetensors filter=lfs diff=lfs merge=lfs -text
29
+ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
30
+ *.tar.* filter=lfs diff=lfs merge=lfs -text
31
+ *.tar filter=lfs diff=lfs merge=lfs -text
32
+ *.tflite filter=lfs diff=lfs merge=lfs -text
33
+ *.tgz filter=lfs diff=lfs merge=lfs -text
34
+ *.wasm filter=lfs diff=lfs merge=lfs -text
35
+ *.xz filter=lfs diff=lfs merge=lfs -text
36
+ *.zip filter=lfs diff=lfs merge=lfs -text
37
+ *.zst filter=lfs diff=lfs merge=lfs -text
38
+ *tfevents* filter=lfs diff=lfs merge=lfs -text
39
+ # Audio files - uncompressed
40
+ *.pcm filter=lfs diff=lfs merge=lfs -text
41
+ *.sam filter=lfs diff=lfs merge=lfs -text
42
+ *.raw filter=lfs diff=lfs merge=lfs -text
43
+ # Audio files - compressed
44
+ *.aac filter=lfs diff=lfs merge=lfs -text
45
+ *.flac filter=lfs diff=lfs merge=lfs -text
46
+ *.mp3 filter=lfs diff=lfs merge=lfs -text
47
+ *.ogg filter=lfs diff=lfs merge=lfs -text
48
+ *.wav filter=lfs diff=lfs merge=lfs -text
49
+ # Image files - uncompressed
50
+ *.bmp filter=lfs diff=lfs merge=lfs -text
51
+ *.gif filter=lfs diff=lfs merge=lfs -text
52
+ *.png filter=lfs diff=lfs merge=lfs -text
53
+ *.tiff filter=lfs diff=lfs merge=lfs -text
54
+ # Image files - compressed
55
+ *.jpg filter=lfs diff=lfs merge=lfs -text
56
+ *.jpeg filter=lfs diff=lfs merge=lfs -text
57
+ *.webp filter=lfs diff=lfs merge=lfs -text
58
+ # Video files - compressed
59
+ *.mp4 filter=lfs diff=lfs merge=lfs -text
60
+ *.webm filter=lfs diff=lfs merge=lfs -text
README.md ADDED
@@ -0,0 +1,149 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ language:
3
+ - ko
4
+ - en
5
+ license: other
6
+ license_name: cc-by-sa-2.0-kr
7
+ license_link: https://creativecommons.org/licenses/by-sa/2.0/kr/
8
+ homepage: https://github.com/taylorsm9/korean_proverbs
9
+ pretty_name: Korean proverbs → English (Urimalsaem)
10
+ tags:
11
+ - korean
12
+ - proverbs
13
+ - urimalsaem
14
+ - machine-translation
15
+ - 속담
16
+ size_categories:
17
+ - 10K<n<100K
18
+ configs:
19
+ - config_name: default
20
+ data_files:
21
+ - split: train
22
+ path: data/korean_proverbs_en.parquet
23
+ annotations_creators:
24
+ - machine-generated
25
+ source_datasets:
26
+ - original
27
+ task_categories:
28
+ - translation
29
+ ---
30
+
31
+ # Korean proverbs → English
32
+
33
+ Every proverb (속담) entry in the Urimalsaem dictionary (우리말샘, National Institute of Korean Language), machine-translated to English. Code and pipeline details: <https://github.com/taylorsm9/korean_proverbs>.
34
+
35
+ ## Structure of this dataset (read this first)
36
+
37
+ Urimalsaem is a sense-level dictionary: a single proverb can have more than one recorded meaning, and each meaning is a separate entry. This dataset follows that structure.
38
+
39
+ - **One row per dictionary sense.** 10,763 rows total.
40
+ - **9,612 unique proverbs.** 1,094 proverbs have two or more senses; the other 8,518 have one.
41
+ - When a proverb has multiple senses, the same `ko` string appears on multiple rows, each with its own `definition_ko` and its own English translation. All senses of a given proverb share the same `headword_raw`.
42
+ - `sense_no` is Urimalsaem's own ordering within a headword (`"001"`, `"002"`, …). This dataset does not pick a primary sense for you.
43
+
44
+ **If you want one row per proverb**, you need to pick a sense yourself. The simplest options:
45
+
46
+ ```python
47
+ # Keep the lowest-numbered sense per proverb (Urimalsaem's own order):
48
+ one_per = df.sort_values(["headword_raw", "sense_no"]).drop_duplicates("headword_raw", keep="first")
49
+ ```
50
+
51
+ ## Scale
52
+
53
+ | Measure | Value |
54
+ |---|---|
55
+ | Total rows | 10,763 |
56
+ | Unique proverbs (unique `headword_raw`) | 9,612 |
57
+ | Proverbs with multiple senses | 1,094 |
58
+
59
+ ## Load it
60
+
61
+ ```python
62
+ from datasets import load_dataset
63
+ ds = load_dataset("NLPatVCU/korean_proverb", split="train")
64
+ df = ds.to_pandas()
65
+ ```
66
+
67
+ Or load the parquet directly:
68
+
69
+ ```python
70
+ import pandas as pd
71
+ from huggingface_hub import hf_hub_download
72
+ path = hf_hub_download("NLPatVCU/korean_proverb", "data/korean_proverbs_en.parquet", repo_type="dataset")
73
+ df = pd.read_parquet(path)
74
+ ```
75
+
76
+ ## Columns
77
+
78
+ | Column | Description |
79
+ |---|---|
80
+ | `id` | Urimalsaem `target_code` for this sense |
81
+ | `headword_raw` | Raw headword text, including Urimalsaem's `[A/B]` / `(C)` variant notation |
82
+ | `ko` | Canonical form of the proverb (variant notation stripped) |
83
+ | `sense_no` | Sense number within this proverb, as assigned by Urimalsaem (`"001"`, `"002"`, …) |
84
+ | `type` | Urimalsaem's usage-category label for this sense (`일반어` is the standard-usage code; see Urimalsaem for the other codes) |
85
+ | `definition_ko` | Dictionary definition (synonym tag and following synonym list are stripped out) |
86
+ | `synonyms_ko` | The stripped synonym list: proverb-length strings that are their own dictionary entries |
87
+ | `proverb_en` | English translation of the proverb |
88
+ | `definition_en` | English translation of the definition |
89
+
90
+ ## Companion embeddings
91
+
92
+ Vector embeddings of the Korean and English texts, computed with two models, are shipped as separate parquet files:
93
+
94
+ ```
95
+ embeddings/
96
+ kanana.parquet # 1,792-dim
97
+ qwen3.parquet # 4,096-dim
98
+ ```
99
+
100
+ Each row carries `id` plus four `list[float32]` columns: `ko_embedding`, `definition_ko_embedding`, `proverb_en_embedding`, `definition_en_embedding`. Join on `id`:
101
+
102
+ ```python
103
+ import pandas as pd
104
+ from huggingface_hub import hf_hub_download
105
+
106
+ df = pd.read_parquet(hf_hub_download("NLPatVCU/korean_proverb", "data/korean_proverbs_en.parquet", repo_type="dataset"))
107
+ emb = pd.read_parquet(hf_hub_download("NLPatVCU/korean_proverb", "embeddings/kanana.parquet", repo_type="dataset"))
108
+ joined = df.merge(emb, on="id")
109
+ ```
110
+
111
+ Both the proverb side and the definition side are embedded with the same prompt, so they share one space (useful for cosine similarity between a proverb and its own meaning). For Qwen3-Embedding the prompt is:
112
+
113
+ ```
114
+ Instruct: Given a Korean or English text, retrieve texts with the same meaning
115
+ Query:
116
+ ```
117
+
118
+ ## Source
119
+
120
+ - 우리말샘 (Urimalsaem), National Institute of Korean Language (국립국어원).
121
+ - Dump dated 2026-06-02, via the GitHub mirror [`spellcheck-ko/korean-dict-nikl`](https://github.com/spellcheck-ko/korean-dict-nikl), pinned to commit `42c0d01`, folder `opendict/` only.
122
+
123
+ ## License
124
+
125
+ - The **dataset** (Korean proverbs, Korean definitions, English translations): **CC-BY-SA-2.0-KR**, matching Urimalsaem. See <https://creativecommons.org/licenses/by-sa/2.0/kr/>. Attribution: 국립국어원 (NIKL), 우리말샘.
126
+ - `embeddings/kanana.parquet`: **CC-BY-NC-4.0** (non-commercial only), inherited from `kakaocorp/kanana-nano-2.1b-embedding`.
127
+ - `embeddings/qwen3.parquet`: **Apache-2.0**, inherited from `Qwen/Qwen3-Embedding-8B`.
128
+
129
+ ## Translation setup
130
+
131
+ - Model: `nvidia/Qwen3.5-122B-A10B-NVFP4` served by vLLM 0.28.0 on an NVIDIA DGX Spark.
132
+ - Thinking off (`enable_thinking: false`) on every request.
133
+ - Sampling: `temperature=0.7, top_p=0.8, top_k=20, min_p=0, presence_penalty=0, repetition_penalty=1.0, max_tokens=1024`.
134
+ - Seed per row: `int(id)`.
135
+ - Output constrained to a Pydantic JSON schema via `response_format`.
136
+ - No translation hit the `max_tokens=1024` ceiling. The longest completion seen was 156 tokens.
137
+
138
+ ## Limitations
139
+
140
+ - Machine-translated; no human review.
141
+ - Multiple rows share the same `ko` when a proverb has multiple senses. Dedupe on `headword_raw` if you want unique proverb strings (see "Structure" above).
142
+ - Only the canonical form of each proverb is translated; variant notation in `headword_raw` is not expanded.
143
+
144
+ ## Citation
145
+
146
+ If you use this dataset, please cite the source dictionary:
147
+
148
+ > 국립국어원 (National Institute of Korean Language). 우리말샘 (Urimalsaem).
149
+ > Available via [`spellcheck-ko/korean-dict-nikl`](https://github.com/spellcheck-ko/korean-dict-nikl).
data/korean_proverbs_en.parquet ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:c04a37ad22c67366f3eda19f1788b50cb808cf4008761341b2314b090195ea20
3
+ size 1581674
embeddings/README.md ADDED
@@ -0,0 +1,37 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Embeddings
2
+
3
+ Per-model parquet files. Each file carries one row per proverb-sense (`id`
4
+ joins back to the main dataset), with four `list[float32]` columns:
5
+
6
+ - `ko_embedding`: embedding of the Korean proverb (`ko`)
7
+ - `definition_ko_embedding`: embedding of the Korean definition
8
+ - `proverb_en_embedding`: embedding of the English translation
9
+ - `definition_en_embedding`: embedding of the English definition
10
+
11
+ | File | Model | Dim | License |
12
+ |---|---|---|---|
13
+ | `kanana.parquet` | `kakaocorp/kanana-nano-2.1b-embedding` | 1,792 | **CC-BY-NC-4.0** (non-commercial) |
14
+ | `qwen3.parquet` | `Qwen/Qwen3-Embedding-8B` | 4,096 | Apache-2.0 |
15
+
16
+ All texts are embedded with the model's query prompt applied identically on
17
+ both sides (both proverb and definition are treated as queries), so a
18
+ same-row proverb and definition live in the same embedding space.
19
+
20
+ Both models receive the **same** instruction string, applied verbatim as a
21
+ prefix to every text (Korean and English, proverb and definition):
22
+
23
+ ```
24
+ Instruct: Given a Korean or English text, retrieve texts with the same meaning
25
+ Query:
26
+ ```
27
+
28
+ Per-model specifics:
29
+
30
+ - `kanana.parquet` (`kakaocorp/kanana-nano-2.1b-embedding`): the prefix
31
+ above is prepended to every input; pooling uses `include_prompt=false`
32
+ (mean-pool over non-prompt tokens), per the Kanana model card.
33
+ - `qwen3.parquet` (`Qwen/Qwen3-Embedding-8B`): the prefix above is passed
34
+ as the model's `custom_prompt` (the Qwen3-Embedding `Instruct: … \nQuery: `
35
+ template), applied identically to every input.
36
+
37
+ Vectors are L2-normalized float32.
embeddings/kanana.parquet ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:ba544f349b7811c509d5b971a7e2a89e78df1e48e2967e0227547ad70abddd01
3
+ size 275977907
embeddings/qwen3.parquet ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:cb0f60dfcc2c0805c0c447d0f0049be8220a02260a5e141ace4845fdb2f02ba3
3
+ size 613156016