Results¶

matchbox.client.results ¶

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

Classes:

Results –

Results of a model run.

Results ¶

Results of a model run.

Contains:

The probabilities of each pair being a match
(Optional) The clusters of connected components at each threshold

Model is required during construction and calculation, but not when loading from storage.

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

Methods:

check_probabilities –

Verifies the probabilities table contains the expected fields.
probabilities_to_polars –

Returns the probability results as a polars DataFrame.
inspect_probabilities –

Enriches the probability results with the source data.
clusters_to_polars –

Returns the cluster results as a polars DataFrame.
inspect_clusters –

Enriches the cluster results with the source data.
root_leaf –

Returns all roots and leaves implied by these results.
to_matchbox –

Writes the results to the Matchbox database.

Attributes:

probabilities (Table) –
model (Model | None) –
metadata (ModelConfig) –
clusters –

Retrieve new clusters implied by these results.

probabilities `instance-attribute` ¶

probabilities: Table

model `class-attribute` `instance-attribute` ¶

model: Model | None = None

metadata `instance-attribute` ¶

metadata: ModelConfig

clusters `property` ¶

clusters

Retrieve new clusters implied by these results.

check_probabilities `classmethod` ¶

check_probabilities(value: Table | DataFrame) -> Table

Verifies the probabilities table contains the expected fields.

probabilities_to_polars ¶

probabilities_to_polars() -> DataFrame

Returns the probability results as a polars DataFrame.

inspect_probabilities ¶

inspect_probabilities(
    left_data: DataFrame,
    left_key: str,
    right_data: DataFrame,
    right_key: str,
) -> DataFrame

Enriches the probability results with the source data.

clusters_to_polars ¶

clusters_to_polars() -> DataFrame

Returns the cluster results as a polars DataFrame.

inspect_clusters ¶

inspect_clusters(
    left_data: DataFrame,
    left_key: str,
    right_data: DataFrame,
    right_key: str,
) -> DataFrame

Enriches the cluster results with the source data.

root_leaf ¶

root_leaf()

Returns all roots and leaves implied by these results.

to_matchbox ¶

to_matchbox() -> None

Writes the results to the Matchbox database.