fix: update GetModelResponse transform to work with any ModelRunner #228
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 of changes:
Currently,
GetModelResponseis a transform that augments the input record with the entire model response payload from calling thepredictmethod of aModelRunner. The response payload is of the form(model_output, log_prob), where bothmodel_outputandlog_probare optional, and whether they are non-null depends on the particularModelRunnerbeing used.When initializing a
GetModelResponse, one must provide a tuple representing the keys that will be associated with the data in a response payload. Algorithms likeSummarizationAccuracythat currently utilizeGetModelReponseonly care about obtaining model outputs (and not the log probabilities), and thus only provide a key for the model output when constructingGetModelResponseinstances.The bug is that
GetModelResponseis currently requiring the response payload to conform to the format of the response payload keys, instead of the other way around. For example, if aGetModelResponseis initialized with the response key tuple(model_output_key, ), then its__call__method will raise an error if the model'spredictmethod returns a payload that contains log probabilities.This PR renames
GetModelResponsetoGetModelOutputsand fixes the bug above. Now,GetModelOutputsis responsible solely for extracting themodel_outputportion of the(model_output, log_probability)predictresponse, and more importantly, the__call__logic does not make any assumptions about the format of the response payload.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.