Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

[Lane 5 · docs] tokenizer.json parity — maturity gate bullet, one documented entry point, tokenizer.json ↔ GGUF field mapping

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#478 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
78/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
kotlin
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với ba trang AsciiDoc được nêu: docs/modules/ROOT/pages/how-to/add-model.adoc, reference/tokenizer-api.adoc và explanation/tokenizer-internals.adoc. Đọc các tệp factory Kotlin để xác nhận entry point được ghi trong tài liệu và dùng .github/workflows/docs.yml để tìm lệnh build tài liệu. Công việc được xem là hoàn tất khi maturity gate liên kết đến golden test và generator, trang API nêu các đường dẫn được ưu tiên và legacy kèm liên kết đến issue, trang internals có phần ánh xạ trường được yêu cầu và kết quả được báo cáo trên #471.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

documentation good first issue size:xs skill:docs sub-issue

Sub-issue of #471 (tokenizer.json parity gate).

Lane: 5 · Docs
Skill needed: AsciiDoc. You should be able to read the two Kotlin factory files to describe what they do; no build knowledge.
Size: xs–s (an hour or two)
Blocked by: nothing; update once the Lane 2 PRs merge.

What to do

  1. add-model.adoc §6 "The maturity gate": add a bullet "Tokenizer golden parity vs Hugging Face tokenizers" — a golden JSON under tests/tokenizer-goldens/ for the family's tokenizer.json, replayed by TokenizerJsonGoldenParityTest (Lane 4), passing for the entry point the family actually uses. Point to the script that generates it.
  2. reference/tokenizer-api.adoc: it presents GGUFTokenizer first and lists GGUFTokenizer.fromTokenizerJson as the way to load a tokenizer.json. Rewrite the "Implementations" section so that TokenizerFactory is the documented entry point, GGUFTokenizer.fromTokenizerJson is marked as the legacy path used by the SafeTensors CLIs with a link to #330, and the known divergences (from #471) are listed with their issue links.
  3. explanation/tokenizer-internals.adoc: add a short "tokenizer.json vs GGUF metadata" subsection — which fields map to which (model.merges ↔ tokenizer.ggml.merges, added_tokens ↔ token_type CONTROL/USER_DEFINED, pre_tokenizer.Metaspace.prepend_scheme ↔ tokenizer.ggml.add_space_prefix), and that post_processor is not applied (callers add BOS/EOS).
  4. Build the docs with the repo's Antora setup if you can (.github/workflows/docs.yml shows the command); otherwise a careful GitHub preview is acceptable for a first PR.

Acceptance

  • Maturity gate lists the tokenizer golden with a link to the test and the script
  • tokenizer-api.adoc names one preferred entry point and links #330 and #471
  • Field mapping table in tokenizer-internals.adoc
  • Result reported back on #471

Notes

The engine repo is adding a tokenizer.json support matrix page (SKaiNET#1321, docs lane). Link to it rather than duplicating which normalizers / pre-tokenizers the engine supports.

Ngôn ngữ chính
Kotlin
Star
8
Fork
3
Merge trung bình
12 giờ 43 phút
Pull request đã merge (30 ngày)
39

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của SKaiNET-developers/SKaiNET-transformers

Tất cả issue của SKaiNET-developers/SKaiNET-transformers

Issue tương tự

Thêm issue về Kotlin

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.