Skip to content

Finalize validation toolkit documentation and examples - #1

Merged
sakthi-kr merged 2 commits into
mainfrom
docs/finalize-validation-toolkit
Jul 24, 2026
Merged

sakthi-kr merged 2 commits into
mainfrom
docs/finalize-validation-toolkit

Conversation

@sakthi-kr

Copy link
Copy Markdown
Owner

Summary

  • finalize the toolkit README around the implemented v0.1.0 API
  • document installation, public functions, CI, integrations, and limitations
  • add an industrial image anomaly-output validation example
  • add an industrial sensor fault-classification validation example
  • add end-to-end tests for both examples
  • keep the existing library API and package version unchanged

Image example

Validates:

  • image-record schema
  • duplicate image paths
  • binary labels
  • anomaly-score ranges
  • binary probability rows
  • accuracy, F1, and AUROC thresholds
  • confusion-matrix consistency

Sensor example

Validates:

  • recording identifiers
  • operating-load and feature ranges
  • four fault classes
  • prediction labels
  • four-class probability rows
  • confidence scores
  • accuracy and macro-F1 thresholds
  • confusion-matrix consistency

Validation

  • focused example tests pass
  • complete toolkit test suite passes
  • both examples run independently
  • both examples produce passing JSON and CSV reports
  • generated example outputs remain excluded from Git

@sakthi-kr
sakthi-kr merged commit f67cb21 into main Jul 24, 2026
2 checks passed
@sakthi-kr
sakthi-kr deleted the docs/finalize-validation-toolkit branch July 24, 2026 14:34
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