Index

A

accumulate() (GroupSampler method) (PairSampler method) Accumulator (class in quaterion.eval.accumulators.accumulator)

ArcFaceLoss (class in quaterion.loss.arcface_loss) AttachedMetric (class in quaterion.eval.attached_metric) AUTO (CacheType attribute), [1] (XbmDevice attribute)

B

BaseDistance (class in quaterion.distances.base_distance) BaseMetric (class in quaterion.eval.base_metric) BaseSampler (class in quaterion.eval.samplers.base_sampler) batch_size (CacheConfig attribute), [1] (GroupSimilarityDataLoader attribute) (PairsSimilarityDataLoader attribute) (SimilarityDataLoader attribute)

buffer_size (XbmConfig attribute)

C

cache_type (CacheConfig attribute), [1] CacheConfig (class in quaterion.train.cache) (class in quaterion.train.cache.cache_config) CacheMixin (class in quaterion.train.cache_mixin) CacheMode (class in quaterion.train.cache.cache_encoder) CacheType (class in quaterion.train.cache) (class in quaterion.train.cache.cache_config) check_encoders_persisted() (CacheMixin class method) CleanupCallback (class in quaterion.train.callbacks.cleanup_callback) collate_labels() (GroupSimilarityDataLoader class method) (PairsSimilarityDataLoader class method) (SimilarityDataLoader class method) compute() (BaseMetric method) (GroupMetric method) (PairMetric method)

configure_caches() (TrainableModel method) configure_columns() (QuaterionProgressBar method) configure_encoders() (TrainableModel method) configure_head() (TrainableModel method) configure_loss() (TrainableModel method) configure_metrics() (TrainableModel method) configure_xbm() (TrainableModel method) ContrastiveLoss (class in quaterion.loss.contrastive_loss) Cosine (class in quaterion.distances.cosine) COSINE (Distance attribute) CPU (CacheType attribute), [1] (XbmDevice attribute) CUDA (XbmDevice attribute)

D

dataset (GroupSimilarityDataLoader attribute) (PairsSimilarityDataLoader attribute) (SimilarityDataLoader attribute) device (XbmConfig attribute) Distance (class in quaterion.distances) distance() (BaseDistance static method) (Cosine static method) (DotProduct static method) (Euclidean static method) (Manhattan static method)

distance_matrix() (BaseDistance static method) (Cosine static method) (DotProduct static method) (Euclidean static method) (Manhattan static method) DOT_PRODUCT (Distance attribute) DotProduct (class in quaterion.distances.dot_product) drop_last (GroupSimilarityDataLoader attribute) (PairsSimilarityDataLoader attribute) (SimilarityDataLoader attribute)

E

embeddings (Accumulator property) Euclidean (class in quaterion.distances.euclidean) EUCLIDEAN (Distance attribute) evaluate() (BaseMetric method) (Evaluator method) (GroupMetric method) (PairMetric method) (Quaterion class method)

Evaluator (class in quaterion.eval.evaluator)

F

FILL (CacheMode attribute) filled (Accumulator property) fit() (Quaterion class method) FixedLengthProcessionSpeed (class in quaterion.utils.progress_bar) flatten_objects() (GroupSimilarityDataLoader class method) (PairsSimilarityDataLoader class method) (SimilarityDataLoader class method) forward() (ArcFaceLoss method) (ContrastiveLoss method) (GroupLoss method) (MultipleNegativesRankingLoss method) (OnlineContrastiveLoss method) (PairwiseLoss method) (PytorchMetricLearningWrapper method) (SoftmaxLoss method) (TripletLoss method)

full_cache_used (SimilarityDataLoader property)

G

get() (XbmBuffer method) get_anchor_negative_mask() (in module quaterion.utils.utils) get_anchor_positive_mask() (in module quaterion.utils.utils) get_by_name() (Distance static method) get_config_dict() (ContrastiveLoss method) (MultipleNegativesRankingLoss method) (OnlineContrastiveLoss method) (SimilarityLoss method) (TripletLoss method) get_masked_maximum() (in module quaterion.utils.utils)

get_masked_minimum() (in module quaterion.utils.utils) get_triplet_mask() (in module quaterion.utils.utils) GPU (CacheType attribute), [1] group (SimilarityGroupSample attribute) GroupAccumulator (class in quaterion.eval.accumulators.group_accumulator) GroupLoss (class in quaterion.loss.group_loss) GroupMetric (class in quaterion.eval.group.group_metric) groups (GroupAccumulator property) GroupSampler (class in quaterion.eval.samplers.group_sampler) GroupSimilarityDataLoader (class in quaterion.dataset.similarity_data_loader)

I

IndexingDataset (class in quaterion.dataset.indexing_dataset) IndexingIterableDataset (class in quaterion.dataset.indexing_dataset)

info_value_of_dtype() (in module quaterion.utils.utils) is_full (XbmBuffer property) iter_by_batch() (in module quaterion.utils.utils)

K

key_extractors (CacheConfig attribute), [1]

KeyExtractorType (in module quaterion.train.cache.cache_config)

L

l2_norm() (in module quaterion.loss.arcface_loss) LabelCacheDataset (class in quaterion.dataset.label_cache_dataset) LabelCacheDatasetMixin (class in quaterion.dataset.label_cache_dataset) LabelCacheIterableDataset (class in quaterion.dataset.label_cache_dataset) LabelCacheMode (class in quaterion.dataset.label_cache_dataset)

labels (PairAccumulator property) learn (LabelCacheMode attribute) load() (LabelCacheDatasetMixin method) load_cache() (CacheMixin class method) load_label_cache() (SimilarityDataLoader method) loss (TrainableModel property)

M

Manhattan (class in quaterion.distances.manhattan) MANHATTAN (Distance attribute) mapping (CacheConfig attribute), [1] max_value_of_dtype() (in module quaterion.utils.utils) MetricsCallback (class in quaterion.train.callbacks.metrics_callback) min_value_of_dtype() (in module quaterion.utils.utils) mode (LabelCacheDatasetMixin property) model (TrainableModel property) module quaterion quaterion.dataset quaterion.dataset.indexing_dataset quaterion.dataset.label_cache_dataset quaterion.dataset.similarity_data_loader quaterion.dataset.similarity_dataset quaterion.dataset.similarity_samples quaterion.dataset.train_collator quaterion.distances quaterion.distances.base_distance quaterion.distances.cosine quaterion.distances.dot_product quaterion.distances.euclidean quaterion.distances.manhattan quaterion.eval quaterion.eval.accumulators quaterion.eval.accumulators.accumulator quaterion.eval.accumulators.group_accumulator quaterion.eval.accumulators.pair_accumulator quaterion.eval.attached_metric quaterion.eval.base_metric quaterion.eval.evaluator quaterion.eval.group quaterion.eval.group.group_metric quaterion.eval.group.retrieval_r_precision quaterion.eval.pair quaterion.eval.pair.pair_metric quaterion.eval.pair.retrieval_precision quaterion.eval.pair.retrieval_reciprocal_rank quaterion.eval.samplers quaterion.eval.samplers.base_sampler quaterion.eval.samplers.group_sampler quaterion.eval.samplers.pair_sampler quaterion.loss quaterion.loss.arcface_loss quaterion.loss.contrastive_loss quaterion.loss.extras quaterion.loss.extras.pytorch_metric_learning_wrapper quaterion.loss.group_loss quaterion.loss.multiple_negatives_ranking_loss quaterion.loss.online_contrastive_loss quaterion.loss.pairwise_loss quaterion.loss.similarity_loss quaterion.loss.softmax_loss quaterion.loss.triplet_loss quaterion.main quaterion.train quaterion.train.cache quaterion.train.cache.cache_config quaterion.train.cache.cache_encoder quaterion.train.cache.cache_model quaterion.train.cache.cache_train_collator quaterion.train.cache.in_memory_cache_encoder quaterion.train.cache_mixin quaterion.train.callbacks quaterion.train.callbacks.cleanup_callback quaterion.train.callbacks.metrics_callback quaterion.train.trainable_model quaterion.train.xbm quaterion.train.xbm.xbm_buffer quaterion.train.xbm.xbm_config quaterion.utils quaterion.utils.enums quaterion.utils.progress_bar quaterion.utils.utils

MultipleNegativesRankingLoss (class in quaterion.loss.multiple_negatives_ranking_loss)

N

NONE (CacheType attribute), [1] num_workers (CacheConfig attribute), [1] (GroupSimilarityDataLoader attribute) (PairsSimilarityDataLoader attribute) (SimilarityDataLoader attribute)

O

obj (SimilarityGroupSample attribute) obj_a (SimilarityPairSample attribute) obj_b (SimilarityPairSample attribute) on_predict_batch_start() (QuaterionProgressBar method) on_predict_end() (QuaterionProgressBar method) on_sanity_check_end() (MetricsCallback method)

on_train_epoch_end() (MetricsCallback method) on_train_epoch_start() (MetricsCallback method) on_validation_epoch_end() (MetricsCallback method) on_validation_epoch_start() (MetricsCallback method) OnlineContrastiveLoss (class in quaterion.loss.online_contrastive_loss) original_params (SimilarityDataLoader property)

P

PairAccumulator (class in quaterion.eval.accumulators.pair_accumulator) PairMetric (class in quaterion.eval.pair.pair_metric) pairs (PairAccumulator property) PairSampler (class in quaterion.eval.samplers.pair_sampler) PairsSimilarityDataLoader (class in quaterion.dataset.similarity_data_loader) PairwiseLoss (class in quaterion.loss.pairwise_loss) pin_memory (GroupSimilarityDataLoader attribute) (PairsSimilarityDataLoader attribute) (SimilarityDataLoader attribute) pin_memory_device (GroupSimilarityDataLoader attribute) (PairsSimilarityDataLoader attribute) (SimilarityDataLoader attribute) pre_collate_fn() (SimilarityDataLoader class method)

pre_encoder_collate() (TrainCollator method) precompute() (BaseMetric method) predict_description (QuaterionProgressBar property) prefetch_factor (GroupSimilarityDataLoader attribute) (PairsSimilarityDataLoader attribute) (SimilarityDataLoader attribute) prepare_labels() (BaseMetric static method) (GroupMetric static method) (PairMetric static method) process_item() (LabelCacheDatasetMixin method) process_meta() (TrainCollator method) process_results() (TrainableModel method) PytorchMetricLearningWrapper (class in quaterion.loss.extras.pytorch_metric_learning_wrapper)

Q

quaterion module Quaterion (class in quaterion.main) quaterion.dataset module quaterion.dataset.indexing_dataset module quaterion.dataset.label_cache_dataset module quaterion.dataset.similarity_data_loader module quaterion.dataset.similarity_dataset module quaterion.dataset.similarity_samples module quaterion.dataset.train_collator module quaterion.distances module quaterion.distances.base_distance module quaterion.distances.cosine module quaterion.distances.dot_product module quaterion.distances.euclidean module quaterion.distances.manhattan module quaterion.eval module quaterion.eval.accumulators module quaterion.eval.accumulators.accumulator module quaterion.eval.accumulators.group_accumulator module quaterion.eval.accumulators.pair_accumulator module quaterion.eval.attached_metric module quaterion.eval.base_metric module quaterion.eval.evaluator module quaterion.eval.group module quaterion.eval.group.group_metric module quaterion.eval.group.retrieval_r_precision module quaterion.eval.pair module quaterion.eval.pair.pair_metric module quaterion.eval.pair.retrieval_precision module quaterion.eval.pair.retrieval_reciprocal_rank module quaterion.eval.samplers module quaterion.eval.samplers.base_sampler module quaterion.eval.samplers.group_sampler module quaterion.eval.samplers.pair_sampler module

quaterion.loss module quaterion.loss.arcface_loss module quaterion.loss.contrastive_loss module quaterion.loss.extras module quaterion.loss.extras.pytorch_metric_learning_wrapper module quaterion.loss.group_loss module quaterion.loss.multiple_negatives_ranking_loss module quaterion.loss.online_contrastive_loss module quaterion.loss.pairwise_loss module quaterion.loss.similarity_loss module quaterion.loss.softmax_loss module quaterion.loss.triplet_loss module quaterion.main module quaterion.train module quaterion.train.cache module quaterion.train.cache.cache_config module quaterion.train.cache.cache_encoder module quaterion.train.cache.cache_model module quaterion.train.cache.cache_train_collator module quaterion.train.cache.in_memory_cache_encoder module quaterion.train.cache_mixin module quaterion.train.callbacks module quaterion.train.callbacks.cleanup_callback module quaterion.train.callbacks.metrics_callback module quaterion.train.trainable_model module quaterion.train.xbm module quaterion.train.xbm.xbm_buffer module quaterion.train.xbm.xbm_config module quaterion.utils module quaterion.utils.enums module quaterion.utils.progress_bar module quaterion.utils.utils module QuaterionProgressBar (class in quaterion.utils.progress_bar) queue() (XbmBuffer method)

R

raw_compute() (BaseMetric method) (GroupMetric method) (PairMetric method) (RetrievalPrecision method) (RetrievalReciprocalRank method) (RetrievalRPrecision method) read (LabelCacheMode attribute) render() (FixedLengthProcessionSpeed method) reset() (Accumulator method) (BaseSampler method) (GroupAccumulator method) (GroupMetric method) (GroupSampler method) (PairAccumulator method) (PairMetric method) (PairSampler method)

reset_metrics() (MetricsCallback static method) retrieval_precision() (in module quaterion.eval.pair.retrieval_precision) retrieval_r_precision() (in module quaterion.eval.group.retrieval_r_precision) retrieval_reciprocal_rank() (in module quaterion.eval.pair.retrieval_reciprocal_rank) RetrievalPrecision (class in quaterion.eval.pair.retrieval_precision) RetrievalReciprocalRank (class in quaterion.eval.pair.retrieval_reciprocal_rank) RetrievalRPrecision (class in quaterion.eval.group.retrieval_r_precision)

S

sample() (BaseSampler method) (GroupSampler method) (PairSampler method) sampler (GroupSimilarityDataLoader attribute) (PairsSimilarityDataLoader attribute) (SimilarityDataLoader attribute) save() (LabelCacheDatasetMixin method) save_cache() (CacheMixin class method) save_dir (CacheConfig attribute), [1] save_label_cache() (SimilarityDataLoader method) save_servable() (TrainableModel method) score (SimilarityPairSample attribute) set_filled() (Accumulator method) set_label_cache_mode() (SimilarityDataLoader method) set_mode() (LabelCacheDatasetMixin method) set_salt() (IndexingDataset method) (IndexingIterableDataset method) (SimilarityDataLoader method) set_skip_read() (IndexingDataset method) (IndexingIterableDataset method) (SimilarityDataLoader method) setup_dataloader() (TrainableModel method)

similarity() (BaseDistance static method) (Cosine static method) (DotProduct static method) (Euclidean static method) (Manhattan static method) similarity_matrix() (BaseDistance static method) (Cosine static method) (DotProduct static method) (Euclidean static method) (Manhattan static method) SimilarityDataLoader (class in quaterion.dataset.similarity_data_loader) SimilarityGroupDataset (class in quaterion.dataset.similarity_dataset) SimilarityGroupSample (class in quaterion.dataset.similarity_samples) SimilarityLoss (class in quaterion.loss.similarity_loss) SimilarityPairSample (class in quaterion.dataset.similarity_samples) SoftmaxLoss (class in quaterion.loss.softmax_loss) start_iteration (XbmConfig attribute) state (Accumulator property) (GroupAccumulator property) (PairAccumulator property) subgroup (SimilarityPairSample attribute) subgroups (PairAccumulator property)

T

teardown() (CleanupCallback method) TEST (TrainStage attribute) timeout (GroupSimilarityDataLoader attribute) (PairsSimilarityDataLoader attribute) (SimilarityDataLoader attribute) TRAIN (CacheMode attribute) (TrainStage attribute) TrainableModel (class in quaterion.train.trainable_model) TrainCollator (class in quaterion.dataset.train_collator) trainer_defaults() (Quaterion static method) training (ArcFaceLoss attribute) (ContrastiveLoss attribute) (GroupLoss attribute) (MultipleNegativesRankingLoss attribute) (OnlineContrastiveLoss attribute) (PairwiseLoss attribute) (PytorchMetricLearningWrapper attribute) (SimilarityLoss attribute) (SoftmaxLoss attribute) (TrainableModel attribute) (TripletLoss attribute)

TrainStage (class in quaterion.utils.enums) transparent (LabelCacheMode attribute) TripletLoss (class in quaterion.loss.triplet_loss)

U

update() (Accumulator method) (GroupAccumulator method) (GroupMetric method) (PairAccumulator method) (PairMetric method)

V

VALIDATION (TrainStage attribute)

W

weight (XbmConfig attribute)

X

xbm_loss() (GroupLoss method) (TripletLoss method)

XbmBuffer (class in quaterion.train.xbm.xbm_buffer) XbmConfig (class in quaterion.train.xbm.xbm_config) XbmDevice (class in quaterion.train.xbm.xbm_config)