Update tokenizer folder

tokenizer/DATASET_USAGE.md

@@ -0,0 +1,36 @@
+# Tokenizer
+
+## Recommended Tokenizer
+
+Use a byte-level BPE tokenizer with explicit FIM and metadata tokens. The
+current local tokenizer uses Hugging Face `tokenizers` JSON format.
+
+Required special tokens:
+
+- `<|fim_prefix|>`
+- `<|fim_suffix|>`
+- `<|fim_middle|>`
+- `<|fim_pad|>`
+- `<|repo|>`
+- `<|file|>`
+- `<|lang|>`
+- `<|endoftext|>`
+- `<|pad|>`
+
+## Usage Rules
+
+- Encode with `add_special_tokens=False` when the record text already contains
+  FIM markers.
+- Decode audits with `skip_special_tokens=False`.
+- Preserve indentation, tabs, newlines, comments, and Korean text.
+- Do not lowercase or normalize code whitespace.
+- Append EOS between JSONL records during training.
+
+## Quality Checks
+
+Audit tokenizer quality with:
+
+- Special tokens remain atomic.
+- Round-trip decode has no byte loss.
+- FIM markers remain visible in decoded samples.
+- Code chars/token is stable across Python, Rust, C++, JavaScript, and Java.

tokenizer/README.md

@@ -1,36 +1,160 @@
-# Tokenizer
+# BPE 토크나이저 (MoE 모델 전용)
 
-## Recommended Tokenizer
+이 디렉토리는 checkpoint/curated JSONL에서 round-robin 샘플링으로 학습된 Byte-level BPE 토크나이저를 포함합니다.
 
-Use a byte-level BPE tokenizer with explicit FIM and metadata tokens. The
-current local tokenizer uses Hugging Face `tokenizers` JSON format.
+---
 
-Required special tokens:
+## 파일 구성
 
-- `<|fim_prefix|>`
-- `<|fim_suffix|>`
-- `<|fim_middle|>`
-- `<|fim_pad|>`
-- `<|repo|>`
-- `<|file|>`
-- `<|lang|>`
-- `<|endoftext|>`
-- `<|pad|>`
+| 파일 | 설명 |
+|---|---|
+| `tokenizer.json` | 학습 완료된 토크나이저 (HuggingFace `tokenizers` 포맷) |
+| `train_tokenizer.py` | BPE 학습 스크립트 (재학습 시 사용) |
+| `encode_demo.py` | 도메인별 인코딩·디코딩 검증 스크립트 |
+| `audit_tokenizer.py` | 압축률, roundtrip, special token, context 초과율 감사 |
 
-## Usage Rules
+---
 
-- Encode with `add_special_tokens=False` when the record text already contains
-  FIM markers.
-- Decode audits with `skip_special_tokens=False`.
-- Preserve indentation, tabs, newlines, comments, and Korean text.
-- Do not lowercase or normalize code whitespace.
-- Append EOS between JSONL records during training.
+## 특수토큰 의미
 
-## Quality Checks
+| 토큰 | ID | 의미 |
+|---|---|---|
+| `<\|fim_prefix\|>` | 0 | FIM (Fill-In-the-Middle): 접두 컨텍스트 시작 마커 |
+| `<\|fim_suffix\|>` | 1 | FIM: 접미 컨텍스트 시작 마커 |
+| `<\|fim_middle\|>` | 2 | FIM: 모델이 생성해야 할 중간 영역 시작 마커 |
+| `<\|endoftext\|>` | 3 | 텍스트 종료 마커 (문서 경계, 패킹 시 사용) |
+| `<\|pad\|>` | 4 | 패딩 토큰 (배치 정렬 시 사용) |
+| `<\|fim_pad\|>` | 5 | FIM 전용 padding/마스킹 확장 |
+| `<\|repo\|>` | 6 | 저장소 컨텍스트 마커 |
+| `<\|file\|>` | 7 | 파일 경로 컨텍스트 마커 |
+| `<\|lang\|>` | 8 | 언어 컨텍스트 마커 |
 
-Audit tokenizer quality with:
+특수토큰은 vocab에서 ID 0~8을 차지하며, BPE merge 대상에서 제외됩니다.
 
-- Special tokens remain atomic.
-- Round-trip decode has no byte loss.
-- FIM markers remain visible in decoded samples.
-- Code chars/token is stable across Python, Rust, C++, JavaScript, and Java.
+---
+
+## FIM 토큰 사용법
+
+FIM(Fill-In-the-Middle)은 코드 중간 삽입 학습을 위한 포맷입니다. `code_fim` 도메인 데이터가 이 포맷을 사용합니다.
+
+```
+<|fim_prefix|>접두 컨텍스트<|fim_suffix|>접미 컨텍스트<|fim_middle|>모델 생성 영역<|endoftext|>
+```
+
+예시:
+
+```python
+text = "<|fim_prefix|>def add(a, b):\n    <|fim_suffix|>\n    return result<|fim_middle|>result = a + b<|endoftext|>"
+encoded = tokenizer.encode(text)
+decoded = tokenizer.decode(encoded.ids, skip_special_tokens=False)  # 특수토큰 보존
+```
+
+주의: `tokenizer.decode()` 호출 시 반드시 `skip_special_tokens=False`를 지정해야 원문이 완벽히 복원됩니다.
+
+---
+
+## Vocab 크기 근거
+
+| 항목 | 값 |
+|---|---|
+| 총 vocab 크기 | 32,000 |
+| 특수토큰 예약 | 9 (ID 0~8) |
+| BPE 병합 학습 토큰 | 31,991 |
+
+**32,000으로 선택한 이유:**
+- 16k는 code_fim 감사 샘플에서 2.72 chars/token 수준이라 컨텍스트 낭비가 컸다.
+- 64k는 압축률은 더 좋아질 수 있지만 MoE+MTP의 vocab projection/head 파라미터가 과도하게 커진다.
+- 32k는 코드 압축률과 MTP head 비용 사이의 균형점이다.
+- 2026-06-11 감사 기준 5,000개 샘플에서 3.49 chars/token, roundtrip failure 0, missing special token 0.
+
+---
+
+## 도메인별 평균 토큰 통계 (1,000개 샘플 기준)
+
+| 도메인 | 평균 토큰 수 | 평균 문자 수 | 압축률 (chars/token) |
+|---|---|---|---|
+| arithmetic | 16.0 | 41.0 | 2.57 |
+| code_fim | 1235.3 | 4306.6 | 3.49 |
+| code_gen | 87.3 | 311.6 | 3.57 |
+| translation | 23.6 | 77.4 | 3.28 |
+
+---
+
+## Byte-level BPE vs Char-level BPE 비교
+
+| 항목 | Byte-level BPE (채택) | Char-level BPE |
+|---|---|---|
+| 한글 처리 | 바이트 분해 후 병합 → 안전 | 직접 char 단위 → 가능 |
+| 코드 심볼(`{`, `\n`, 들여쓰기) | 바이트 단위로 정확히 보존 | char 단위로 가능하나 공백 처리 복잡 |
+| OOV(미지 문자) | 없음 (256 바이트로 모든 텍스트 표현) | 희귀 유니코드 문자 미포함 가능 |
+| 라운드트립 보장 | 완벽 보장 (`skip_special_tokens=False`) | 완벽 보장 |
+| HuggingFace `tokenizers` 호환 | `ByteLevel` pre-tokenizer 공식 지원 | `CharDelimiterSplit` 등 별도 설정 필요 |
+| 참고 모델 | GPT-2, GPT-NeoX, Llama | BPE-dropout, 일부 인코더 모델 |
+
+Byte-level BPE를 채택한 핵심 이유: 한글·코드·수식이 혼재하는 데이터에서 OOV 없이 모든 입력을 처리해야 하기 때문입니다.
+
+---
+
+## 토크나이저 재학습 방법
+
+데이터가 추가된 후 토크나이저를 재학습하는 명령:
+
+```bash
+# 기본: checkpoint/curated/raw JSONL을 round-robin으로 샘플링
+python3 tokenizer/train_tokenizer.py
+
+# 현재 권장 32k 재학습
+python3 tokenizer/train_tokenizer.py --vocab-size 32000 --lines-per-file 3000 --max-total-lines 180000
+
+# 더 큰 실험용 64k. MoE+MTP head 파라미터가 크게 늘어나므로 ablation으로만 권장
+python3 tokenizer/train_tokenizer.py --vocab-size 64000 --lines-per-file 5000 --max-total-lines 300000
+```
+
+재학습 후에는 반드시 검증을 실행하세요:
+
+```bash
+python3 tokenizer/encode_demo.py
+python3 tokenizer/audit_tokenizer.py --max-records 5000
+```
+
+라운드트립 결과가 `OK`인지 확인합니다.
+
+---
+
+## Python 코드에서 사용하기
+
+```python
+from tokenizers import Tokenizer
+
+# 로드
+tokenizer = Tokenizer.from_file("tokenizer/tokenizer.json")
+
+# 인코딩
+text = "def hello():\n    print('안녕')"
+encoded = tokenizer.encode(text)
+print(encoded.ids)    # 토큰 ID 리스트
+print(encoded.tokens) # 토큰 문자열 리스트
+
+# 디코딩 (특수토큰 포함 복원)
+decoded = tokenizer.decode(encoded.ids, skip_special_tokens=False)
+
+# 배치 인코딩
+texts = ["text1", "text2"]
+encoded_batch = tokenizer.encode_batch(texts)
+
+# 특수토큰 ID 조회
+vocab = tokenizer.get_vocab()
+pad_id = vocab["<|pad|>"]      # 4
+eos_id = vocab["<|endoftext|>"] # 3
+fim_prefix_id = vocab["<|fim_prefix|>"]  # 0
+```
+
+---
+
+## 학습 환경
+
+- OS: macOS (Apple M4, 48GB)
+- Python: 3.x
+- tokenizers: 0.23.1
+- 학습 데이터: `data/curated_upload/*.jsonl` 60개 파일에서 파일당 3,000개, 총 180,000 샘플
+- 학습 시간: 약 30초 내외 (M4, 32k smoke 기준)