Index

_

__getitem__() (oml.datasets.audios.AudioBaseDataset method) (oml.datasets.audios.AudioLabeledDataset method) (oml.datasets.audios.AudioQueryGalleryDataset method) (oml.datasets.audios.AudioQueryGalleryLabeledDataset method) (oml.datasets.images.ImageBaseDataset method) (oml.datasets.images.ImageLabeledDataset method) (oml.datasets.images.ImageQueryGalleryDataset method) (oml.datasets.images.ImageQueryGalleryLabeledDataset method) (oml.datasets.pairs.PairDataset method) (oml.datasets.texts.TextBaseDataset method) (oml.datasets.texts.TextLabeledDataset method) (oml.datasets.texts.TextQueryGalleryDataset method) (oml.datasets.texts.TextQueryGalleryLabeledDataset method) (oml.interfaces.datasets.IBaseDataset method) (oml.interfaces.datasets.IIndexedDataset method) (oml.interfaces.datasets.ILabeledDataset method) (oml.interfaces.datasets.IPairDataset method) __init__() (oml.datasets.audios.AudioBaseDataset method) (oml.datasets.audios.AudioLabeledDataset method) (oml.datasets.audios.AudioQueryGalleryDataset method) (oml.datasets.audios.AudioQueryGalleryLabeledDataset method) (oml.datasets.images.ImageBaseDataset method) (oml.datasets.images.ImageLabeledDataset method) (oml.datasets.images.ImageQueryGalleryDataset method) (oml.datasets.images.ImageQueryGalleryLabeledDataset method) (oml.datasets.pairs.PairDataset method) (oml.datasets.texts.TextBaseDataset method) (oml.datasets.texts.TextLabeledDataset method) (oml.datasets.texts.TextQueryGalleryDataset method) (oml.datasets.texts.TextQueryGalleryLabeledDataset method) (oml.ddp.patching.DDPSamplerWrapper method) (oml.interfaces.datasets.IPairDataset method) (oml.losses.arcface.ArcFaceLoss method) (oml.losses.arcface.ArcFaceLossWithMLP method) (oml.losses.surrogate_precision.SurrogatePrecision method) (oml.losses.triplet.TripletLoss method) (oml.losses.triplet.TripletLossPlain method) (oml.losses.triplet.TripletLossWithMiner method) (oml.metrics.embeddings.EmbeddingMetrics method) (oml.miners.cross_batch.TripletMinerWithMemory method) (oml.miners.inbatch_all_tri.AllTripletsMiner method) (oml.miners.inbatch_hard_cluster.HardClusterMiner method) (oml.miners.inbatch_hard_tri.HardTripletsMiner method) (oml.miners.inbatch_nhard_tri.NHardTripletsMiner method) (oml.miners.miner_with_bank.MinerWithBank method) (oml.models.meta.projection.ExtractorWithMLP method) (oml.models.meta.siamese.ConcatSiamese method) (oml.models.meta.siamese.LinearTrivialDistanceSiamese method) (oml.models.meta.siamese.TrivialDistanceSiamese method) (oml.models.resnet.extractor.ResnetExtractor method) (oml.models.vit_clip.extractor.ViTCLIPExtractor method) (oml.models.vit_dino.extractor.ViTExtractor method) (oml.retrieval.postprocessors.algo.AdaptiveThresholding method) (oml.retrieval.postprocessors.algo.ConstantThresholding method) (oml.retrieval.postprocessors.pairwise.PairwiseReranker method) (oml.retrieval.retrieval_results.RetrievalResults method) (oml.samplers.balance.BalanceSampler method) (oml.samplers.category_balance.CategoryBalanceSampler method) (oml.samplers.distinct_category_balance.DistinctCategoryBalanceSampler method) (oml.utils.misc_torch.PCA method)

__iter__() (oml.interfaces.samplers.IBatchSampler method) __len__() (oml.interfaces.samplers.IBatchSampler method) _reload() (oml.ddp.patching.DDPSamplerWrapper method) _sample() (oml.interfaces.miners.ITripletsMinerInBatch method)

A

AdaptiveThresholding (class in oml.retrieval.postprocessors.algo) AllTripletsMiner (class in oml.miners.inbatch_all_tri) ArcFaceLoss (class in oml.losses.arcface) ArcFaceLossWithMLP (class in oml.losses.arcface)

assign_2d() (in module oml.utils.misc_torch) AudioBaseDataset (class in oml.datasets.audios) AudioLabeledDataset (class in oml.datasets.audios) AudioQueryGalleryDataset (class in oml.datasets.audios) AudioQueryGalleryLabeledDataset (class in oml.datasets.audios)

B

BalanceSampler (class in oml.samplers.balance)

C

calc_cmc() (in module oml.functional.metrics) calc_fnmr_at_fmr() (in module oml.functional.metrics) calc_fnmr_at_fmr_rr() (in module oml.metrics.embeddings) calc_map() (in module oml.functional.metrics) calc_pcf() (in module oml.functional.metrics) calc_precision() (in module oml.functional.metrics) calc_principal_axes_number() (oml.utils.misc_torch.PCA method) calc_retrieval_metrics() (in module oml.functional.metrics)

calc_retrieval_metrics_rr() (in module oml.metrics.embeddings) calc_topological_metrics() (in module oml.functional.metrics) CategoryBalanceSampler (class in oml.samplers.category_balance) check_retrieval_dataframe_format() (in module oml.utils.dataframe_format) components (oml.utils.misc_torch.PCA attribute) compute_metrics() (oml.interfaces.metrics.IBasicMetric method) (oml.metrics.embeddings.EmbeddingMetrics method) ConcatSiamese (class in oml.models.meta.siamese) ConstantThresholding (class in oml.retrieval.postprocessors.algo)

D

DDPSamplerWrapper (class in oml.ddp.patching) deepcopy() (oml.retrieval.retrieval_results.RetrievalResults method) distances (oml.retrieval.retrieval_results.RetrievalResults property)

DistinctCategoryBalanceSampler (class in oml.samplers.distinct_category_balance) draw_attention() (oml.models.vit_dino.extractor.ViTExtractor method) draw_gradcam() (oml.models.resnet.extractor.ResnetExtractor method)

E

EmbeddingMetrics (class in oml.metrics.embeddings) explained_variance (oml.utils.misc_torch.PCA attribute)

explained_variance_ratio (oml.utils.misc_torch.PCA attribute) extract() (oml.interfaces.models.IExtractor method) ExtractorWithMLP (class in oml.models.meta.projection)

F

feat_dim (oml.interfaces.models.IExtractor property) (oml.models.resnet.extractor.ResnetExtractor property) (oml.models.vit_clip.extractor.ViTCLIPExtractor property) (oml.models.vit_dino.extractor.ViTExtractor property) forward() (oml.interfaces.criterions.ITripletLossWithMiner method) (oml.interfaces.models.IPairwiseModel method) (oml.losses.surrogate_precision.SurrogatePrecision method) (oml.losses.triplet.TripletLoss method) (oml.losses.triplet.TripletLossPlain method) (oml.losses.triplet.TripletLossWithMiner method) (oml.models.meta.siamese.ConcatSiamese method) (oml.models.meta.siamese.LinearTrivialDistanceSiamese method) (oml.models.meta.siamese.TrivialDistanceSiamese method)

freeze() (oml.interfaces.models.IFreezable method) (oml.models.meta.siamese.ConcatSiamese method) from_embeddings() (oml.retrieval.retrieval_results.RetrievalResults class method) from_embeddings_qg() (oml.retrieval.retrieval_results.RetrievalResults class method) from_pretrained() (oml.interfaces.models.IExtractor class method)

G

get_gallery_ids() (oml.datasets.audios.AudioQueryGalleryDataset method) (oml.datasets.audios.AudioQueryGalleryLabeledDataset method) (oml.datasets.images.ImageQueryGalleryDataset method) (oml.datasets.images.ImageQueryGalleryLabeledDataset method) (oml.datasets.texts.TextQueryGalleryDataset method) (oml.datasets.texts.TextQueryGalleryLabeledDataset method) (oml.interfaces.datasets.IQueryGalleryDataset method) (oml.interfaces.datasets.IQueryGalleryLabeledDataset method) get_label2category() (oml.datasets.audios.AudioLabeledDataset method) (oml.datasets.audios.AudioQueryGalleryLabeledDataset method) (oml.datasets.images.ImageLabeledDataset method) (oml.datasets.images.ImageQueryGalleryLabeledDataset method) (oml.datasets.texts.TextLabeledDataset method) (oml.datasets.texts.TextQueryGalleryLabeledDataset method) (oml.interfaces.datasets.ILabeledDataset method) (oml.interfaces.datasets.IQueryGalleryLabeledDataset method) get_labels() (oml.datasets.audios.AudioLabeledDataset method) (oml.datasets.audios.AudioQueryGalleryLabeledDataset method) (oml.datasets.images.ImageLabeledDataset method) (oml.datasets.images.ImageQueryGalleryLabeledDataset method) (oml.datasets.texts.TextLabeledDataset method) (oml.datasets.texts.TextQueryGalleryLabeledDataset method) (oml.interfaces.datasets.ILabeledDataset method) (oml.interfaces.datasets.IQueryGalleryLabeledDataset method)

get_mock_audios_dataset() (in module oml.utils.download_mock_dataset) get_mock_images_dataset() (in module oml.utils.download_mock_dataset) get_mock_texts_dataset() (in module oml.utils.download_mock_dataset) get_plot_for_queries() (oml.metrics.embeddings.EmbeddingMetrics method) get_plot_for_worst_queries() (oml.metrics.embeddings.EmbeddingMetrics method) get_query_ids() (oml.datasets.audios.AudioQueryGalleryDataset method) (oml.datasets.audios.AudioQueryGalleryLabeledDataset method) (oml.datasets.images.ImageQueryGalleryDataset method) (oml.datasets.images.ImageQueryGalleryLabeledDataset method) (oml.datasets.texts.TextQueryGalleryDataset method) (oml.datasets.texts.TextQueryGalleryLabeledDataset method) (oml.interfaces.datasets.IQueryGalleryDataset method) (oml.interfaces.datasets.IQueryGalleryLabeledDataset method) get_worst_queries_ids() (oml.metrics.embeddings.EmbeddingMetrics method) gt_ids (oml.retrieval.retrieval_results.RetrievalResults property)

H

HardClusterMiner (class in oml.miners.inbatch_hard_cluster)

HardTripletsMiner (class in oml.miners.inbatch_hard_tri)

I

IBaseDataset (class in oml.interfaces.datasets) IBasicMetric (class in oml.interfaces.metrics) IBatchSampler (class in oml.interfaces.samplers) IExtractor (class in oml.interfaces.models) IFreezable (class in oml.interfaces.models) IHTMLVisualizableDataset (class in oml.interfaces.datasets) IIndexedDataset (class in oml.interfaces.datasets) ILabeledDataset (class in oml.interfaces.datasets) ImageBaseDataset (class in oml.datasets.images) ImageLabeledDataset (class in oml.datasets.images) ImageQueryGalleryDataset (class in oml.datasets.images)

ImageQueryGalleryLabeledDataset (class in oml.datasets.images) inverse_transform() (oml.utils.misc_torch.PCA method) IPairDataset (class in oml.interfaces.datasets) IPairwiseModel (class in oml.interfaces.models) IQueryGalleryDataset (class in oml.interfaces.datasets) IQueryGalleryLabeledDataset (class in oml.interfaces.datasets) IRetrievalPostprocessor (class in oml.interfaces.retrieval) is_empty() (oml.retrieval.retrieval_results.RetrievalResults method) ITripletLossWithMiner (class in oml.interfaces.criterions) ITripletsMiner (class in oml.interfaces.miners) ITripletsMinerInBatch (class in oml.interfaces.miners) IVisualizableDataset (class in oml.interfaces.datasets)

L

label_smoothing() (in module oml.functional.label_smoothing) last_logs (oml.losses.arcface.ArcFaceLoss property) (oml.losses.arcface.ArcFaceLossWithMLP property) (oml.losses.triplet.TripletLoss property) (oml.losses.triplet.TripletLossPlain property) (oml.losses.triplet.TripletLossWithMiner property) (oml.miners.miner_with_bank.MinerWithBank property)

LinearTrivialDistanceSiamese (class in oml.models.meta.siamese)

M

mean (oml.utils.misc_torch.PCA attribute)

MinerWithBank (class in oml.miners.miner_with_bank)

N

n_retrieved_items (oml.retrieval.retrieval_results.RetrievalResults property)

NHardTripletsMiner (class in oml.miners.inbatch_nhard_tri)

P

PairDataset (class in oml.datasets.pairs) PairwiseReranker (class in oml.retrieval.postprocessors.pairwise) patch_dataloader_to_ddp() (in module oml.ddp.patching) PCA (class in oml.utils.misc_torch) predict() (oml.interfaces.models.IPairwiseModel method) (oml.models.meta.siamese.ConcatSiamese method)

process() (oml.interfaces.retrieval.IRetrievalPostprocessor method) (oml.retrieval.postprocessors.algo.AdaptiveThresholding method) (oml.retrieval.postprocessors.algo.ConstantThresholding method) (oml.retrieval.postprocessors.pairwise.PairwiseReranker method)

R

ResnetExtractor (class in oml.models.resnet.extractor)

RetrievalResults (class in oml.retrieval.retrieval_results) retrieved_ids (oml.retrieval.retrieval_results.RetrievalResults property)

S

sample() (oml.interfaces.miners.ITripletsMiner method) (oml.interfaces.miners.ITripletsMinerInBatch method) (oml.miners.cross_batch.TripletMinerWithMemory method) (oml.miners.inbatch_all_tri.AllTripletsMiner method) (oml.miners.inbatch_hard_cluster.HardClusterMiner method) (oml.miners.inbatch_hard_tri.HardTripletsMiner method) (oml.miners.inbatch_nhard_tri.NHardTripletsMiner method) (oml.miners.miner_with_bank.MinerWithBank method)

setup() (oml.interfaces.metrics.IBasicMetric method) (oml.metrics.embeddings.EmbeddingMetrics method) singular_values (oml.utils.misc_torch.PCA attribute) SurrogatePrecision (class in oml.losses.surrogate_precision) sync_dicts_ddp() (in module oml.ddp.utils)

T

take_2d() (in module oml.utils.misc_torch) TextBaseDataset (class in oml.datasets.texts) TextLabeledDataset (class in oml.datasets.texts) TextQueryGalleryDataset (class in oml.datasets.texts) TextQueryGalleryLabeledDataset (class in oml.datasets.texts) top_n (oml.retrieval.postprocessors.pairwise.PairwiseReranker property)

transform() (oml.utils.misc_torch.PCA method) TripletLoss (class in oml.losses.triplet) TripletLossPlain (class in oml.losses.triplet) TripletLossWithMiner (class in oml.losses.triplet) TripletMinerWithMemory (class in oml.miners.cross_batch) TrivialDistanceSiamese (class in oml.models.meta.siamese)

U

unfreeze() (oml.interfaces.models.IFreezable method) (oml.models.meta.siamese.ConcatSiamese method)

update() (oml.metrics.embeddings.EmbeddingMetrics method) update_data() (oml.interfaces.metrics.IBasicMetric method)

V

visualize() (oml.datasets.audios.AudioBaseDataset method) (oml.datasets.audios.AudioLabeledDataset method) (oml.datasets.audios.AudioQueryGalleryDataset method) (oml.datasets.audios.AudioQueryGalleryLabeledDataset method) (oml.datasets.images.ImageBaseDataset method) (oml.datasets.images.ImageLabeledDataset method) (oml.datasets.images.ImageQueryGalleryDataset method) (oml.datasets.images.ImageQueryGalleryLabeledDataset method) (oml.datasets.texts.TextBaseDataset method) (oml.datasets.texts.TextLabeledDataset method) (oml.datasets.texts.TextQueryGalleryDataset method) (oml.datasets.texts.TextQueryGalleryLabeledDataset method) (oml.interfaces.datasets.IVisualizableDataset method) (oml.metrics.embeddings.EmbeddingMetrics method) (oml.retrieval.retrieval_results.RetrievalResults method)

visualize_as_html() (oml.datasets.audios.AudioBaseDataset method) (oml.datasets.audios.AudioLabeledDataset method) (oml.datasets.audios.AudioQueryGalleryDataset method) (oml.datasets.audios.AudioQueryGalleryLabeledDataset method) (oml.interfaces.datasets.IHTMLVisualizableDataset method) visualize_qg() (oml.retrieval.retrieval_results.RetrievalResults method) visualize_with_functions() (oml.retrieval.retrieval_results.RetrievalResults method) ViTCLIPExtractor (class in oml.models.vit_clip.extractor) ViTExtractor (class in oml.models.vit_dino.extractor)