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] Precision/Recall/F1 — doc partials (math / intuition / examples / references)

Đang mở
  • Có gì không ổn?
#1,234 0 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ó
3/5
Thời gian dự kiến
Nửa ngày
Mức phù hợp với người mới
72/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
kotlin, latex
Lĩnh vực
documentation

Hướng nghiên cứu

Start by reading docs/modules/ROOT/partials/ops/tensorops/matmul.adoc for the tag structure and the metrics how-to page for its existing example pattern. Create the three specified partials and include their tagged content in docs/modules/ROOT/pages/how-to/metrics-and-perf-testing.adoc; the examples tag depends on #1229. Build the site using the contributing guide or docs.yml workflow, and verify the math renders, the example compiles, and the reference links resolve.

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:s skill:docs sub-issue

Sub-issue of #1222 (Precision, Recall and F1Score metrics).

Lane: 5 · Docs / DARC
Skill needed: AsciiDoc and technical writing; enough ML background to explain precision vs. recall. No Kotlin beyond reading a 30-line class.
Size: s (~2–3 h for all three)
Blocked by: nothing for the math / intuition / references tags (start now); the examples tag needs #1229 so the example actually runs.

What to do

  1. Write three partials, one per metric, following the tag structure of
    docs/modules/ROOT/partials/ops/tensorops/matmul.adoc:
    • docs/modules/ROOT/partials/ops/metrics/precision.adoc
    • docs/modules/ROOT/partials/ops/metrics/recall.adoc
    • docs/modules/ROOT/partials/ops/metrics/f1score.adoc
      Each with non-placeholder // tag::math[], // tag::intuition[], // tag::examples[],
      // tag::references[] blocks. Use stem:[…] / [stem] (LaTeX; the playbook sets
      stem: latexmath) for the formulas. The math block must state the per-class
      definition, what macro vs. micro averaging does, and the zero-division convention
      adopted in #1224.
  2. Metrics are not TensorOps functions, so the operator-doc generator will not pick
    these partials up automatically. Surface them by adding a "Precision, recall and F1"
    subsection to docs/modules/ROOT/pages/how-to/metrics-and-perf-testing.adoc that
    include::partial$ops/metrics/f1score.adoc[tag=intuition] (and the others by tag).
  3. The examples block must be real code that compiles against develop after #1229 —
    ideally a tagged snippet in skainet-docs-samples included via include::example$…,
    like the existing TrainingDemo.kt accuracy example on that page; a plain
    [source,kotlin] block is acceptable if you say why.
  4. Build the site locally (see Contributing → Build from source / the docs.yml
    workflow) and check the math renders.

Acceptance

  • Three partials, all four tags non-empty, math renders
  • Metrics how-to page shows the new section with the intuition text and a runnable example
  • Every reference link resolves and supports the claim next to it (the reviewer in
    #1235 will click each one)

Notes

Intuition to convey: precision answers "of what I predicted positive, how much was right";
recall answers "of what was actually positive, how much did I catch"; F1 is their harmonic
mean, so it punishes a classifier that is high on one only because the other is near zero —
which is exactly where raw accuracy stays silent (predict the majority class everywhere:
high accuracy, near-zero minority recall). Also spell out that macro F1 is the mean of
per-class F1s, not the F1 of the macro means.

References to start from: sklearn precision_recall_fscore_support, torchmetrics
F1Score, and https://en.wikipedia.org/wiki/F-score .

Ngôn ngữ chính
Kotlin
Star
52
Fork
15
Merge trung bình
1 ngày 8 giờ
Pull request đã merge (30 ngày)
37

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

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

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

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.