Specify metrics in threshold_perf() #37
Closed
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
So that the user can specify which metrics are computed when calling threshold_perf(), we add a new
metrics
argument that accepts ayardstick
metric set.By default this argument is
NULL
, in which case the function computes the default metrics. If notNULL
, the function checks that it's an appropriate metric set (class metrics only) and computes only the metrics provided in the set.Motivation and Context
Fixes #25
How Has This Been Tested?
Tested using yardstick 0.0.7 on R 4.0.2.
Types of changes
Checklist:
Note that I did not add an example in the docs of
threshold_perf()
that uses the new feature.