neurovlm.core.TextSearchResult

class neurovlm.core.TextSearchResult(scores_by_dataset, metadata_by_dataset, query_embeddings, retrieval_space)

Container for text retrieval scores and metadata.

Parameters:

• scores_by_dataset (Dict[str, Tensor])

• metadata_by_dataset (Dict[str, DataFrame])

• query_embeddings (Tensor)

• retrieval_space (Literal['raw_text', 'shared'])

__init__(scores_by_dataset, metadata_by_dataset, query_embeddings, retrieval_space)

Parameters:

• scores_by_dataset (Dict[str, Tensor])

• metadata_by_dataset (Dict[str, DataFrame])

• query_embeddings (Tensor)

• retrieval_space (Literal['raw_text', 'shared'])

Return type:

None

Methods

__init__(scores_by_dataset, ...)
format([k, query_index, dataset])	Build a printable summary for top-k text results.
plot(*args, **kwargs)	Text results are not directly plottable as brain maps.
print([k, query_index, dataset])	Print top-k text results.
top_k([k, query_index, dataset])	Return top-k text matches as one merged dataframe.

Attributes

df	Return a dataframe view of ranked text retrieval results.
scores_by_dataset
metadata_by_dataset
query_embeddings
retrieval_space