Skip to content

docs: Add validation to list of packages in readme#524

Open
JNygaard-Skylight wants to merge 1 commit intomainfrom
josh/520-validation-to-readme
Open

docs: Add validation to list of packages in readme#524
JNygaard-Skylight wants to merge 1 commit intomainfrom
josh/520-validation-to-readme

Conversation

@JNygaard-Skylight
Copy link
Copy Markdown
Collaborator

Description

Add validation to list of packages in readme.

Related Issues

Closes #520

<--------------------- REMOVE THE LINES BELOW BEFORE MERGING --------------------->

Checklist

Please review and complete the following checklist before submitting your pull request:

  • I have ensured that the pull request is of a manageable size, allowing it to be reviewed within a single session.
  • I have reviewed my changes to ensure they are clear, concise, and well-documented.
  • I have updated the documentation, if applicable.
  • I have added or updated test cases to cover my changes, if applicable.
  • I have minimized the number of reviewers to include only those essential for the review.

Checklist for Reviewers

Please review and complete the following checklist during the review process:

  • The code follows best practices and conventions.
  • The changes implement the desired functionality or fix the reported issue.
  • The tests cover the new changes and pass successfully.
  • Any potential edge cases or error scenarios have been considered.

@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.80%. Comparing base (bee0a3f) to head (226bc51).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #524   +/-   ##
=======================================
  Coverage   95.80%   95.80%           
=======================================
  Files          46       46           
  Lines        2336     2336           
=======================================
  Hits         2238     2238           
  Misses         98       98           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Comment thread README.md
| [`model-tuning`](packages/model-tuning/) | Fine-tunes SentenceTransformer models and builds HNSW indexes for OpenSearch |
| [`api`](packages/api/) | FastAPI service exposing `/api` endpoints; serves the built frontend in non-local environments |
| [`frontend`](frontend/) | React 19 + TypeScript + Vite demo application for interacting with the API |
| [`validation`](packages/validation/) | Functionality to validate an eICR and to create Schematron output |
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any where that we have documented how to use this validation package or is this just only going to be part of the e2e testing? Or maybe you leveraged the one that was part of the former eicr validation tool repo?

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.

Add Validation to package list in readme

3 participants