API Reference

Feature Extraction

Extracting feature vectors from images

extract.FeatureExtractor Extract features from images.

Identify

Predicting IDs in a query set with a reference set

identify.predict_ids Predict the identities of individuals in the query set

Sorting and Clustering

Clustering images by proposed IDs

sort.HierarchicalCluster Hierarchical clustering of images
sort.NetworkCluster Network clustering of images
sort.ClusterResults Storing NetworkCluster results.
sort.prep_images Copy all images to a flat directory and save a csv with encounter info.
sort.sort_images Sort images into subfolders by proposed ID then encounter.
sort.load_features Load previously extracted features.

Grading

Grade images by distinctiveness

grade.rate_distinctiveness Grade images by their distinctiveness.

Verifying Installation

Functions to make sure PyTorch is working

get_best_device Select torch device based on expected performance.
verify_pytorch Verify PyTorch installation and show device options.