Skip to content

Document multi-measure Perf support - #33

Open
mgraffg wants to merge 1 commit into
mainfrom
develop
Open

Document multi-measure Perf support#33
mgraffg wants to merge 1 commit into
mainfrom
develop

Conversation

@mgraffg

@mgraffg mgraffg commented Aug 22, 2026

Copy link
Copy Markdown
Member

Summary

  • Documents Plan: Multi-measure API for Perf/Difference (e.g. macro-F1 + macro-recall together) #30's multi-measure Perf/Difference support (score_func/error_func as lists, mixed BiB directions, .measure() factory), which previously had tests and inline docstrings but no user-facing documentation.
  • metrics_docs() (utils.py) now explains .measure() for every metrics.py wrapper; progress_bar and dataframe get full docstrings.
  • Translated the two stray Spanish comments in bootstrap.py to English.
  • Added a worked multi-measure walkthrough to docs/source/metrics_api.rst and a new "Multi-measure Support" page in quarto/CompStats.qmd, including a mention of the macro_f1/macro_recall/macro_precision convenience wrappers.

Closes #32.

Test plan

  • pytest CompStats — 65 passed, 0 failed (pre-existing sklearn/numpy deprecation warnings only)
  • Documentation-only change, no behavior changes (per issue's stated non-goals)

🤖 Generated with Claude Code

…#32)

Documents #30's multi-measure Perf/Difference support, which had tests and
inline docstrings but no user-facing documentation: metrics_docs() now
explains .measure(), utils.py helpers get full docstrings, the two stray
Spanish comments in bootstrap.py are translated, and both metrics_api.rst
and CompStats.qmd gain a worked multi-measure walkthrough plus a mention of
the macro_f1/macro_recall/macro_precision convenience wrappers.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document missing functions/features and add multi-measure examples (from #30)

1 participant