api: Include labels in DeID service model card #14
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
baixiac
approved these changes
Jun 26, 2025
Member
baixiac
left a comment
baixiac
left a comment
There was a problem hiding this comment.
LGTM.
Somehow the default branch was renamed to main and pls update "master"s inside .github/workflows to bring back the CI.
Signed-off-by: Phoevos Kalemkeris <phoevos.kalemkeris@ucl.ac.uk>
Extend the base model card schema to allow passing a mapping of labels, i.e. concept IDs (e.g. CUIs) to names. This is particularly useful when using the MedCAT model DeID service, which is typically configured to serve models with a relatively small CDB that can be exposed in its entirety as part of the model card. This information can be interesting to the user (or client application), providing insight into the concepts that the model is capable of identifying and by extension enabling them to decide and control which of them should be redacted. The 'labels' field is always included in the API's responses when the '/info' endpoint is called, but is only populated with the mapping in a dict format when the CMS instance is configured to use the MedCAT model DeID service. Signed-off-by: Phoevos Kalemkeris <phoevos.kalemkeris@ucl.ac.uk>
phoevos
force-pushed
the
feature-phoevos-deid-add-labels
branch
from
eb02316 to
668e5b3
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Extend the base model card schema to allow passing a mapping of labels, i.e. concept IDs (e.g. CUIs) to names. This is particularly useful when using the MedCAT model DeID service, which is typically configured to serve models with a relatively small CDB that can be exposed in its entirety as part of the model card. This information can be interesting to the user (or client application), providing insight into the concepts that the model is capable of identifying and by extension enabling them to decide and control which of them should be redacted. The
labelsfield is always included in the API's responses when the/infoendpoint is called, but is only populated with the mapping in a dict format when the CMS instance is configured to use the MedCAT model DeID service.