Skip to content

Results

matchbox.client.results

Objects representing the results of running a model client-side.

Classes:

  • Results –

    Results of a model run.

Results 

Results(probabilities: DataFrame, left_root_leaf: DataFrame | None = None, right_root_leaf: DataFrame | None = None)

Results of a model run.

Contains:

  • The probabilities of each pair being a match
  • (Optional) The clusters of connected components at each threshold
  • (Optional) The leaf_id mapping to trace results back to source clusters

Allows users to easily interrogate the outputs of models, explore decisions on choosing thresholds for clustering, and upload the results to Matchbox.

Methods:

  • root_leaf –

    Returns all roots and leaves implied by these results.

Attributes:

left_root_leaf instance-attribute 

left_root_leaf = None

right_root_leaf instance-attribute 

right_root_leaf = None

probabilities instance-attribute 

probabilities: DataFrame = cast(Schema(SCHEMA_RESULTS))

clusters property 

clusters

Retrieve new clusters implied by these results.

root_leaf 

root_leaf()

Returns all roots and leaves implied by these results.