Upload project README

PROJECT_README.md

@@ -0,0 +1,328 @@
+# KAWK50M
+
+한국어 문서 중심으로 처음부터 학습하는 약 50M 파라미터의 Llama 계열
+decoder-only 언어모델 프로젝트입니다. 1,024 컨텍스트에서 20B 토큰
+사전학습 후 5,120 컨텍스트에서 3B 토큰을 계속학습하는
+`KAWK-1.5-50M Korean Base` 파이프라인을 포함합니다. BASE 모델이므로 지시
+응답 모델을 만들려면 완료 후 별도의 한국어 SFT가 필요합니다.
+
+## 모델 사양
+
+| 항목 | 값 |
+|---|---:|
+| 파라미터 | **51,542,528** |
+| 어휘 | 20,000 |
+| 레이어 | 14 |
+| hidden / MLP | 512 / 1,408 |
+| Attention / KV heads | 8 / 4 |
+| 문맥 길이 | 1,024 (계속학습 단계 5,120) |
+| 활성화·정규화 | SwiGLU(SiLU) · RMSNorm |
+| 위치 표현 | RoPE (`theta=10000`) |
+| 임베딩 | 입력·출력 공유 |
+
+영어·코드 전용 문서는 데이터 필터에서 제외합니다. 다만 `KTX`, `Windows`,
+제품명, 연도처럼 한국어 문장에 자연스럽게 포함된 영문과 숫자는 보존합니다.
+토크나이저는 NFC 완성형 한글을 입력으로 받는 SentencePiece Unigram이며,
+드문 문자와 이모지의 `<unk>` 발생을 막기 위해 byte fallback을 사용합니다.
+
+## 구성
+
+```text
+configs/
+  model_50m.yaml          51.54M 모델 구조
+  model_50m_5k.yaml       동일 가중치 구조의 5,120 RoPE 확장 설정
+  pretrain_5b.yaml        5B 토큰 본 학습 설정
+  pretrain_5b_5090.yaml   RunPod RTX 5090용 5B 설정
+  pretrain_v2_100m_5090.yaml  엄격 정제 데이터 100M 검증 설정
+  pretrain_v2_20b_5090.yaml   엄격 한국어 20B 베이스 설정
+  cpt_v2_3b_5k_5090.yaml  5,120 문맥 3B 계속학습 설정
+  pretrain_smoke.yaml     5-step 연결 검증 설정
+kawk50m/
+  text.py                 NFC 정규화, PII 마스킹, 한국어 품질 필터
+  io.py                   JSONL/TXT 스트리밍 입출력
+  binary_dataset.py       uint16 메모리맵 학습 데이터
+  checkpoint.py           원자적 체크포인트 저장·재개
+scripts/
+  prepare_corpus.py       정제, 필터, 정확·근사 중복 제거, 문서 단위 분할
+  audit_corpus.py         필터 통계·하위 품질 문서 표본 감사
+  train_tokenizer.py      한국어 20K Unigram 학습
+  tokenize_corpus.py      EOS 경계 삽입 및 토큰 바이너리 생성
+  stream_tokenize_fineweb2.py  고정 revision FineWeb2 직접 토큰 스트리밍
+  stream_tokenize_chatml.py    허용 라이선스 한국어 구조 데이터 필터·토큰화
+  prepare_cpt_mix.py      2.9B 장문 + 0.1B 구조 데이터 CPT 혼합
+  model_info.py           모델 크기 확인
+  estimate_corpus_tokens.py  정제 말뭉치의 예상 토큰 수 측정
+  benchmark.py            현재 GPU의 BF16 합성 학습 처리량 측정
+  preflight.py            토크나이저·토큰 데이터·GPU 사전검사
+  pretrain.py             BF16 단일/다중 GPU 사전학습
+  evaluate.py             validation loss와 한국어 이어쓰기 평가
+  evaluate_text.py        동일 원문의 UTF-8 byte 기준 모델 비교
+  build_model_card.py     최종 계보·지표 기반 모델 카드 생성
+runpod/
+  bootstrap.sh            Pod Python 환경 준비
+  train_5090.sh           사전검사·벤치마크·학습 실행
+  stream_v2_20b.sh        4-worker 재개 가능 20B 데이터 생성
+  continue_kawk_1_5_after_stream.sh  20B → 3B CPT 자동 실행
+```
+
+생성 데이터와 체크포인트는 `.gitignore`에 포함됩니다. 각 생성 스크립트는
+기존 결과 파일을 발견하면 덮어쓰지 않고 중단합니다.
+
+## 1. 설치
+
+Python 3.10 이상과 CUDA 지원 PyTorch 환경을 권장합니다. 아래 명령은
+PowerShell에서 프로젝트 루트를 현재 폴더로 둔 경우입니다.
+
+```powershell
+python -m venv .venv
+.\.venv\Scripts\Activate.ps1
+python -m pip install --upgrade pip
+python -m pip install -e .
+```
+
+이미 적합한 PyTorch가 설치된 환경이면 다음처럼 설치할 수도 있습니다.
+
+```powershell
+python -m pip install -r requirements.txt
+```
+
+모든 CLI는 프로젝트 루트에서 `python -m scripts.<이름>` 형식으로 실행합니다.
+
+## 2. 원본 데이터 형식
+
+`.jsonl`, `.jsonl.gz`, `.txt`, `.txt.gz`를 지원합니다. JSONL의 최소 형식은
+다음과 같습니다.
+
+```json
+{"id":"문서-ID","text":"한국어 문서 본문","source":"출처명","url":null,"license":"이용조건"}
+```
+
+`id`, `source`, `url`, `license`는 선택 사항이지만, 공개 모델을 만들 때는
+출처와 라이선스를 반드시 보존하는 것을 권장합니다. TXT는 기본적으로 한
+줄을 한 문서로 처리합니다. 파일 하나가 문서 하나라면
+`--txt-mode document`를 사용합니다.
+
+공개 웹 말뭉치, 허가받은 국립국어원·AI Hub 자료, 위키백과 등을 로컬
+`data/raw/` 아래에 준비하십시오. 이 저장소는 데이터 라이선스 동의나
+다운로드 승인을 대신하지 않습니다.
+
+FineWeb2 한국어로 100M 토큰 파이프라인 ���증용 샘플을 만들 때:
+
+```powershell
+python -m pip install -r requirements-data.txt
+python -m scripts.download_fineweb2 `
+  --output-dir data/raw/fineweb2-kor-pilot `
+  --max-documents 300000
+```
+
+다운로드는 현재 Hugging Face dataset commit을 기록하고, 5만 문서 단위
+`jsonl.gz`로 저장합니다. 중단됐다면 같은 명령에 `--resume`을 추가합니다.
+FineWeb2는 ODC-By 1.0이며 CommonCrawl 이용 조건도 적용됩니다.
+
+## 3. 정제와 데이터 분할
+
+```powershell
+python -m scripts.prepare_corpus `
+  --input "data/raw/**/*.jsonl" "data/raw/**/*.jsonl.gz" `
+  --output-dir data/clean
+```
+
+기본 처리:
+
+- Unicode NFC 통일, 잔여 HTML·제어문자 제거
+- 이메일·휴대전화·주민등록번호 형태 마스킹
+- 전체 가시문자·문자 중 한국어 비율을 각각 검사
+- 숫자, 기호, URL, 짧은 메뉴 줄, 표·목록, 반복 문자, 상용구 과다 문서 제외
+- SHA-256 정확 중복 및 문단/chunk sketch 기반 근사 중복 제거(SQLite 사용)
+- 문서 해시 기반 `train 99.7% / validation 0.2% / test 0.1%` 분할
+
+기본 임계값은 출발점입니다. 필터 전후 문서를 표본 검사한 뒤 말뭉치에 맞게
+조정하십시오. 특히 `prepare_stats.json`의 거절 사유와
+`scripts.audit_corpus`가 저장한 최저 품질 표본을 확인해야 합니다.
+
+## 4. 한국어 20K 토크나이저
+
+```powershell
+python -m scripts.train_tokenizer `
+  --input "data/clean/train-*.jsonl" `
+  --output-dir artifacts/tokenizer-20k `
+  --vocab-size 20000 `
+  --max-sentences 2000000
+```
+
+토크나이저 학습용 문서는 전체 출처에서 균형 있게 준비해야 합니다. 뉴스에
+치우치면 뉴스 문체 조각이 어휘를 과도하게 차지할 수 있습니다. 결과의
+`training_metadata.json`에서 한국어·영문 혼합·숫자·이모지 probe의
+`unknown_tokens`와 round trip을 확인하십시오.
+
+모델 설정과 토크나이저 어휘 수는 반드시 같아야 합니다.
+
+```powershell
+python -m scripts.model_info --config configs/model_50m.yaml
+```
+
+## 5. 토큰화와 1,024 토큰 패킹
+
+```powershell
+python -m scripts.tokenize_corpus `
+  --input-dir data/clean `
+  --tokenizer-dir artifacts/tokenizer-20k `
+  --output-dir data/tokenized
+```
+
+각 문서 끝에 EOS를 넣고 `train.bin`, `validation.bin`, `test.bin`을 생성합니다.
+어휘가 65,535개 이하이므로 토큰은 `uint16`으로 저장됩니다. 학습 시에는
+평평한 토큰 스트림에서 1,025개를 읽어 1,024개 입력과 한 토큰 이동한
+label을 만듭니다. 5B 토큰 바이너리는 약 10GB입니다.
+
+파이프라인 확인만 할 때는 토큰 수를 제한할 수 있습니다.
+
+```powershell
+python -m scripts.tokenize_corpus `
+  --input-dir data/clean `
+  --tokenizer-dir artifacts/tokenizer-20k `
+  --output-dir data/tokenized-smoke `
+  --max-train-tokens 200000 `
+  --max-validation-tokens 20000 `
+  --max-test-tokens 20000
+```
+
+## 6. 사전학습
+
+먼저 5 step으로 모델·데이터·체크포인트 연결을 검증합니다.
+
+```powershell
+python -m scripts.pretrain --config configs/pretrain_smoke.yaml
+```
+
+본 학습:
+
+```powershell
+python -m scripts.pretrain --config configs/pretrain_5b.yaml
+```
+
+RunPod RTX 5090을 사용할 때는
+[runpod/README.md](runpod/README.md)와 `configs/pretrain_5b_5090.yaml`을
+사용합니다.
+
+Supra-1.5 방식의 전체 한국어 20B + 3B 장문 파이프라인은 다음 순서입니다.
+
+```bash
+bash runpod/tokenize_v2_initial.sh
+bash runpod/stream_v2_20b.sh
+bash runpod/train_v2_20b.sh
+bash runpod/prepare_cpt_v2_3b.sh
+bash runpod/train_cpt_v2_3b_5k.sh
+```
+
+`stream_v2_20b.sh`가 중단됐다면 기존 상태를 검증한 뒤 다음처럼 이어갑니다.
+
+```bash
+RESUME=1 bash runpod/stream_v2_20b.sh
+```
+
+스트리밍 완료 후 나머지를 자동 실행하려면
+`runpod/continue_kawk_1_5_after_stream.sh`를 사용합니다. 최종 모델 카드,
+평가 JSON, 체크섬과 체크포인트 경로는
+`reports/kawk-1.5-50m-v2/`에 생성됩니다.
+
+`pretrain_5b.yaml`의 단일 GPU 기준 유효 배치는
+`8 × 16 × 1,024 = 131,072 tokens/step`입니다. 5B 토큰은 38,147
+optimizer step으로 올림되어 실제 계획량은 5,000,003,584토큰입니다.
+RTX GPU에서는 BF16과 fused AdamW를 사용하며, 설정상 `torch.compile`도
+요청합니다. Triton이 없는 Windows 환경에서는 자동으로 eager BF16으로
+전환됩니다. compile을 명시적으로 끄려면 `--no-compile`을 붙이십시오.
+
+현재 GPU에서 같은 배치 설정의 계산 처리량을 먼저 측정할 수 있습니다.
+
+```powershell
+python -m scripts.benchmark
+python -m scripts.benchmark --compile
+```
+
+결과의 시간은 합성 데이터 기준이므로 실제 계획에는 데이터 공급, 평가,
+체크포인트 시간을 추가해야 합니다.
+
+중단 지점 재개:
+
+```powershell
+python -m scripts.pretrain `
+  --config configs/pretrain_5b.yaml `
+  --resume latest
+```
+
+베��스 체크포인트의 가중치만 가져와 문맥 길이·데이터·학습률을 바꾼
+계속학습을 시작할 때는 `--init-from`을 사용합니다. 이 옵션은 optimizer,
+scheduler, RNG와 step을 새로 시작하며 `--resume`과 동시에 쓸 수 없습니다.
+
+```powershell
+python -m scripts.pretrain `
+  --config configs/cpt_v2_3b_5k_5090.yaml `
+  --init-from runs/kawk50m-v2-20b-5090/checkpoint-XXXXXXXX
+```
+
+점검 목적으로 계획된 scheduler는 유지한 채 이번 실행만 짧게 멈추려면 다음처럼
+사용할 수 있습니다. 중지 지점 체크포인트가 자동 저장됩니다.
+
+```powershell
+python -m scripts.pretrain `
+  --config configs/pretrain_5b.yaml `
+  --stop-after-steps 100
+```
+
+두 GPU 예시:
+
+```powershell
+torchrun --standalone --nproc_per_node=2 -m scripts.pretrain `
+  --config configs/pretrain_5b.yaml
+```
+
+재개 시 GPU 수(`world_size`)는 체크포인트를 만들 때와 같아야 합니다.
+체크포인트는 `runs/.../checkpoint-XXXXXXXX/`에 모델, 토크나이저,
+optimizer/scheduler/RNG 상태를 함께 저장합니다.
+
+## 7. 평가와 생성
+
+```powershell
+python -m scripts.evaluate `
+  --checkpoint runs/kawk50m-5b/checkpoint-00038147 `
+  --validation-bin data/tokenized/validation.bin
+```
+
+직접 prompt를 여러 번 줄 수도 있습니다.
+
+```powershell
+python -m scripts.evaluate `
+  --checkpoint runs/kawk50m-5b/checkpoint-00038147 `
+  --prompt "대한민국의 수도는" `
+  --prompt "오늘 학교에서"
+```
+
+토크나이저가 다른 모델끼리는 token-level perplexity를 그대로 비교하면
+안 됩니다. 같은 원문에 대한 UTF-8 byte당 또는 글자당 negative
+log-likelihood는 다음처럼 비교합니다.
+
+```powershell
+python -m scripts.evaluate_text `
+  --checkpoint runs/kawk50m-5b/checkpoint-00038147 `
+  --input "data/clean/validation-*.jsonl" `
+  --max-documents 1000
+```
+
+서로 다른 모델에 반드시 같은 순서의 원문 파일과 문서 수를 사용하고,
+`bits_per_utf8_byte`가 낮은 모델을 더 좋은 결과로 해석합니다. 생성 결과는 BASE 모델의
+이어쓰기이며 질문 답변 능력을 의미하지 않습니다.
+
+## 테스트
+
+```powershell
+python -m pytest
+```
+
+본 학습 전에 최소한 다음을 확인하십시오.
+
+1. `prepare_stats.json`의 거절 사유와 출처별 실제 문서 표본
+2. 토크나이저 probe에 `<unk>`가 없고 디코딩이 원문을 보존하는지
+3. 5-step smoke 학습에서 loss가 유한하고 체크포인트 재개가 되는지
+4. 10M → 100M → 1B 토큰 순으로 생성 품질과 validation loss가 개선되는지
+5. 평가 문서가 train의 정확·근사 중복 문서가 아닌지