baybe.telemetry.telemetry_record_recommended_measurement_percentage¶
- baybe.telemetry.telemetry_record_recommended_measurement_percentage(cached_recommendation: DataFrame, measurements: DataFrame, parameters: list[Parameter], numerical_measurements_must_be_within_tolerance: bool)[source]¶
Submit the percentage of added measurements.
More precisely, submit the percentage of added measurements that correspond to previously recommended ones (called cached recommendations).
The matching is performed via fuzzy row matching, using the utils function
baybe.utils.dataframe.fuzzy_row_match()
. The calculation is only performed if telemetry is enabled. If no cached recommendation exists the percentage is not calculated and instead a different event (‘naked initial measurement added’) is recorded.- Parameters:
cached_recommendation (
DataFrame
) – The cached recommendations.measurements (
DataFrame
) – The measurements which are supposed to be checked against cached recommendations.parameters (
list
[Parameter
]) – The list of parameters spanning the entire search space.numerical_measurements_must_be_within_tolerance (
bool
) – IfTrue
, numerical parameter entries are matched with the reference elements only if there is a match within the parameter tolerance. IfFalse
, the closest match is considered, irrespective of the distance.
- Return type: