Fix the schema for keypoint detection in workflows #946
+18
−18
Conversation
This file contains 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
shantanubala
requested review from
PawelPeczek-Roboflow,
grzegorz-roboflow,
yeldarby,
probicheaux and
hansent
as code owners
shantanubala
commented
Jan 14, 2025
| @@ -227,7 +227,7 @@ class Keypoint(Point): | |||
| description="Model confidence regarding keypoint visibility." | |||
| ) | |||
| class_id: int = Field(description="Identifier of keypoint.") | |||
| class_name: str = Field(field="class", description="Type of keypoint.") | |||
| class_name: str = Field(alias="class", description="Type of keypoint.") | |||
There was a problem hiding this comment.
@PawelPeczek-Roboflow You likely know more about what is happening here much better than I do - I couldn't figure out why this was field= instead of alias=, but this adjustment seems to more closely match the data we are actually passing around.
Do you foresee any unintended consequences of making this change? I might also be completely wrong in my approach to fixing this bug, would appreciate your input 🙏
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.
Description
This PR fixes what appears to be a bug in keypoint detection models used in Workflows using keypoint detection models due to the naming conventions in inference - here is a screen recording of the bug:
workflow-keyp.mp4
It appears that we use
class_nameandclass_idnaming conventions in most cases, but the baseKeypointsDetectionBaseOnnxRoboflowInferenceModelusesclassandclass_idinstead.Error message:
{ "error": "Failed to assemble `model_predictions`. Could not successfully use any deserializer for declared kinds. Details: \nKind: `keypoint_detection_prediction` - Error: 'class_name'", "inner_error": "None" }Type of change
Please delete options that are not relevant.
How has this change been tested, please provide a testcase or example of how you tested the change?
I need some help here - I'm not 100% sure what might be depending on the old schema, or whether this change to the object will break downstream code.
Any specific deployment considerations
Will this break anything depending on this old schema?
Docs
N/A