Predictions

class Predictions(df: DataFrame, factory: CoreTriplesFactory | None)[source]

Bases: ABC

Base class for predictions.

Methods Summary

add_membership_columns(**filter_triples)

Add columns indicating whether the triples are known.

exchange_df(df)

Create a copy of the object with its dataframe exchanged.

filter_triples(*triples)

Filter out known triples.

Methods Documentation

Parameters:
add_membership_columns(**filter_triples: tuple[str, str, str] | Sequence[tuple[str, str, str]] | ndarray | Tensor | CoreTriplesFactory | None) DataFrame[source]

Add columns indicating whether the triples are known.

Parameters:

filter_triples (tuple[str, str, str] | Sequence[tuple[str, str, str]] | ndarray | Tensor | CoreTriplesFactory | None)

Return type:

DataFrame

exchange_df(df: DataFrame) Predictions[source]

Create a copy of the object with its dataframe exchanged.

Parameters:

df (DataFrame)

Return type:

Predictions

filter_triples(*triples: tuple[str, str, str] | Sequence[tuple[str, str, str]] | ndarray | Tensor | CoreTriplesFactory | None) DataFrame[source]

Filter out known triples.

Parameters:

triples (tuple[str, str, str] | Sequence[tuple[str, str, str]] | ndarray | Tensor | CoreTriplesFactory | None)

Return type:

DataFrame