Skip to main content

Descriptors

Descriptors Objects​

class Descriptors(Entities)

Python wrapper for ApertureDB Descriptors API.

find_similar​

def find_similar(set: str,
                 vector,
                 k_neighbors: int,
                 constraints=None,
                 distances: bool = False,
                 blobs: bool = False,
                 results={"all_properties": True})

Find similar descriptors to the input descriptor.

Arguments:

  • set str - Descriptor set name.
  • vector list - Input descriptor vector.
  • k_neighbors int - Number of neighbors to return.
  • constraints aperturedb.Constraints.Constraints, optional - Constraints for the search. Defaults to None.
  • distances bool, optional - Return similarity metric values. Defaults to False.
  • blobs bool, optional - Return vectors of the neighbors. Defaults to False.
  • results dict, optional - Dictionary with the results format. Defaults to {"all_properties": True}.

Returns:

  • None - Populates self.response with the parsed JSON response from the database.

find_similar_mmr​

def find_similar_mmr(set: str,
                     vector,
                     k_neighbors: int,
                     fetch_k: int,
                     lambda_mult: float = 0.5,
                     **kwargs)

As find_similar, but using the MMR algorithm to diversify the results.

Arguments:

  • set str - Descriptor set name.
  • vector list - Input descriptor vector.
  • k_neighbors int - Number of results to return.
  • fetch_k int - Number of neighbors to fetch from the database.
  • lambda_mult float - Lambda multiplier for the MMR algorithm. Defaults to 0.5. 1.0 means no diversity.