[Lane 2 · kotlin-core] Precision/Recall/F1 — Averaging enum + internal ConfusionMatrixAccumulator
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- Half a day
- Newbie friendliness
- 48/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- kotlin
- Domain
- machine-learning
Research direction
First read Accuracy.kt, the helpers from #1225, and the contract decisions in #1224; this issue is blocked on both. Implement the public Averaging enum and the internal accumulator and reducer in sk.ainet.lang.nn.metrics, then test the reducer’s modes and zero-division case. Run ./gradlew :skainet-lang:skainet-lang-core:apiDump; done means the API dump adds Averaging only and the fixture produces the specified counts.
Written by the indexing model from the issue text.
Description
Sub-issue of #1222 (Precision, Recall and F1Score metrics).
Lane: 2 · Kotlin core
Skill needed: Kotlin; read Accuracy.kt and the helpers from #1225 first.
Size: s (~3–4 h)
Blocked by: #1225 (helpers) and the contract decisions from #1224 (zero-division, macro class set, binary mode).
What to do
- Add
public enum class Averaging { BINARY, MACRO, MICRO }in
sk.ainet.lang.nn.metrics(own file, KDoc on each value — this is public API).
Semantics per #1224; the working definitions are:BINARY— report class1(the positive class) only; requires ≤ 2 classes;MACRO— unweighted mean of the per-class value over the class set decided in #1224;MICRO— pool TP / FP / FN over all classes, then apply the formula once.
- Add
internal class ConfusionMatrixAccumulator(dim: Int = -1, threshold: Float? = null)
withfun <T : DType, V> update(predictions: Tensor<T, V>, targets: Tensor<out DType, *>)
— walks every sample via the #1225 helper and increments per-classtp/fp/fn
(Longcounters keyed by class index; a wrong prediction is one FP for the predicted
class and one FN for the target class);fun counts(): Map<Int, ClassCounts>(a smallinternal data class ClassCounts(tp, fp, fn));fun reset().
- Add
internal fun reduce(counts, averaging, perClass: (tp: Long, fp: Long, fn: Long) -> Double): Double
implementing the three averaging modes and the zero-division convention from #1224
in one place, soPrecision,RecallandF1Scoreeach contribute only a formula. - Tests: the accumulator is
internaltoskainet-lang-core, and the metric tests live
inskainet-backend-cpu(they needDirectCpuExecutionContextto build tensors). Two
options — pick one and say which in the PR:- test it through
Precision/Recallin #1227 / #1228 (then this PR ships
with areduce()unit test only, which needs no tensors), or - put an accumulator test in
skainet-lang-core'scommonTest, building tensors with
DenseTensorDataFactory().fromFloatArray(...)+SimpleTensor(...)the way
OperationExecutor.createTensordoes.
- test it through
./gradlew :skainet-lang:skainet-lang-core:apiDump— the dump gainsAveragingand
nothing else.
Acceptance
-
Averagingpublic, documented, in the API dump -
ConfusionMatrixAccumulator+reduce()internal, no public surface -
reduce()tested for macro / micro / binary and the zero-division case - Reference fixture from #1224 (
pred [2,0,1,2],target [2,1,1,0]) yields counts
{0: (0,1,1), 1: (1,0,1), 2: (1,1,0)}as (tp, fp, fn)
Notes
Don't build Precision / Recall / F1Score here even though it's tempting — they are
separate good first issues (#1227, #1228, #1229) precisely so three people can each
ship one small PR against this accumulator.
- Dominant language
- Kotlin
- Stars
- 52
- Forks
- 15
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 36
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from SKaiNET-developers/SKaiNET
-
coding good first issue size:xs skill:kotlin-core sub-issue
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
SKaiNET-developers/SKaiNET#1323 ·
Maintainers usually reply within 1 day
-
coding good first issue platform size:xs skill:js sub-issue
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
SKaiNET-developers/SKaiNET#1232 ·
Maintainers usually reply within 1 day
-
skeep tracking
Difficulty 5/5 Over a week Newbie friendliness 15/100
SKaiNET-developers/SKaiNET#1331 ·
Maintainers usually reply within 1 day
-
assessment size:s skill:review sub-issue
Difficulty 4/5 1-2 days Newbie friendliness 18/100
SKaiNET-developers/SKaiNET#1330 ·
Maintainers usually reply within 1 day
-
documentation good first issue size:s skill:docs sub-issue
Difficulty 3/5 1-2 days Newbie friendliness 78/100
SKaiNET-developers/SKaiNET#1329 ·
Maintainers usually reply within 1 day
All issues in SKaiNET-developers/SKaiNET
Similar issues
-
Default book icon displayed while loadingPossibly taken @Bhaskar-Guthula-137 claimed this today. Openbug good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
kiwix/kiwix-android#5194 · 1 comment ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
jellyfin/jellyfin-androidtv#5885 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 73/100
tortuvshin/open-apps#377 ·
Maintainers usually reply within 1 day
-
contributor: external needs review
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 79/100
supabase-community/supabase-kt#1413 ·
Maintainers usually reply within 5 days