Skip to content

Add docs - #6

Merged
MunchProductionz merged 1 commit into
masterfrom
add-docs
Apr 5, 2026
Merged

Add docs#6
MunchProductionz merged 1 commit into
masterfrom
add-docs

Conversation

@MunchProductionz

Copy link
Copy Markdown
Owner

This pull request significantly expands the documentation for the evaluation framework, adding conceptual guides and clarifying the motivation, design, and behavior of the library. The changes introduce new documentation pages covering evaluation-driven development, alignment strategies, feature rules, metrics, and logging, while also updating the README.md to better explain the library's purpose. Additionally, a GitHub Actions workflow is added to automate documentation builds and deployment.

Documentation Improvements:

  • Added new conceptual documentation pages:

    • Evaluation-driven development: Explains the motivation, iterative workflow, and the role of domain experts in the evaluation process.
    • Alignment: Details how predictions are matched to gold data, including strategies for different task types and matching modes.
    • Feature rules: Describes how features are compared, including normalization, tolerances, and matching weights.
    • Metrics: Outlines the reported metrics, their meanings, and special considerations for different feature types and multi-entity tasks.
    • Logging: Documents how evaluation logs are generated, what they contain, and how to interpret them.
  • Updated README.md to clarify the motivation for the library, the evaluation-driven development loop, and how the library fits into real-world workflows.

Automation:

  • Added a GitHub Actions workflow (.github/workflows/docs.yml) to build and deploy documentation automatically on pushes and pull requests.

@MunchProductionz
MunchProductionz merged commit aa12365 into master Apr 5, 2026
2 checks passed
@MunchProductionz
MunchProductionz deleted the add-docs branch April 5, 2026 04:33
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.

1 participant