Open Metric Learning
latest
OML
Installation
FAQ
Contributing guide
Dataset format
Pipelines
Logging & Visualization
Features extraction
Examples
Models Zoo
Pipelines: features extraction
Postprocessing
Examples
Models Zoo
Pairwise postprocessing (re-ranking)
Contents
Base Interfaces
Datasets
Samplers
Miners
Losses
Models
Metrics
PyTorch Lightning
Utils
DDP
Retrieval Post-Processing
Open Metric Learning
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
P
|
R
|
S
|
T
|
U
|
V
_
__getitem__() (oml.datasets.images.ImageBaseDataset method)
(oml.datasets.images.ImageLabeledDataset method)
(oml.datasets.images.ImageQueryGalleryDataset method)
(oml.datasets.images.ImageQueryGalleryLabeledDataset method)
(oml.datasets.pairs.EmbeddingPairsDataset method)
(oml.datasets.pairs.ImagePairsDataset method)
(oml.interfaces.datasets.ILabeledDataset method)
(oml.interfaces.datasets.IPairsDataset method)
__init__() (oml.datasets.images.ImageBaseDataset method)
(oml.datasets.images.ImageLabeledDataset method)
(oml.datasets.images.ImageQueryGalleryDataset method)
(oml.datasets.images.ImageQueryGalleryLabeledDataset method)
(oml.datasets.pairs.EmbeddingPairsDataset method)
(oml.datasets.pairs.ImagePairsDataset method)
(oml.ddp.patching.DDPSamplerWrapper method)
(oml.interfaces.datasets.IPairsDataset method)
(oml.lightning.callbacks.metric.MetricValCallback method)
(oml.lightning.callbacks.metric.MetricValCallbackDDP method)
(oml.lightning.modules.ddp.ModuleDDP method)
(oml.lightning.modules.extractor.ExtractorModule method)
(oml.lightning.modules.extractor.ExtractorModuleDDP 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.metrics.embeddings.EmbeddingMetricsDDP 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.pairwise.PairwiseEmbeddingsPostprocessor method)
(oml.retrieval.postprocessors.pairwise.PairwiseImagesPostprocessor 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
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)
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_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_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)
(oml.metrics.embeddings.EmbeddingMetricsDDP method)
ConcatSiamese (class in oml.models.meta.siamese)
D
DDPSamplerWrapper (class in oml.ddp.patching)
DistinctCategoryBalanceSampler (class in oml.samplers.distinct_category_balance)
download_mock_dataset() (in module oml.utils.download_mock_dataset)
draw_attention() (oml.models.vit_dino.extractor.ViTExtractor method)
draw_gradcam() (oml.models.resnet.extractor.ResnetExtractor method)
E
EmbeddingMetrics (class in oml.metrics.embeddings)
EmbeddingMetricsDDP (class in oml.metrics.embeddings)
EmbeddingPairsDataset (class in oml.datasets.pairs)
explained_variance (oml.utils.misc_torch.PCA attribute)
explained_variance_ratio (oml.utils.misc_torch.PCA attribute)
extract() (oml.interfaces.models.IExtractor method)
extractor_prediction_pipeline() (in module oml.lightning.pipelines.predict)
extractor_training_pipeline() (in module oml.lightning.pipelines.train)
extractor_validation_pipeline() (in module oml.lightning.pipelines.validate)
ExtractorModule (class in oml.lightning.modules.extractor)
ExtractorModuleDDP (class in oml.lightning.modules.extractor)
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_pretrained() (oml.interfaces.models.IExtractor class method)
G
get_gallery_ids() (oml.datasets.images.ImageQueryGalleryDataset method)
(oml.datasets.images.ImageQueryGalleryLabeledDataset method)
(oml.interfaces.datasets.IQueryGalleryDataset method)
(oml.interfaces.datasets.IQueryGalleryLabeledDataset method)
get_labels() (oml.datasets.images.ImageLabeledDataset method)
(oml.datasets.images.ImageQueryGalleryLabeledDataset method)
(oml.interfaces.datasets.ILabeledDataset method)
(oml.interfaces.datasets.IQueryGalleryLabeledDataset method)
get_plot_for_queries() (oml.metrics.embeddings.EmbeddingMetrics method)
get_plot_for_worst_queries() (oml.metrics.embeddings.EmbeddingMetrics method)
get_query_ids() (oml.datasets.images.ImageQueryGalleryDataset method)
(oml.datasets.images.ImageQueryGalleryLabeledDataset method)
(oml.interfaces.datasets.IQueryGalleryDataset method)
(oml.interfaces.datasets.IQueryGalleryLabeledDataset method)
get_worst_queries_ids() (oml.metrics.embeddings.EmbeddingMetrics method)
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)
IDistancesPostprocessor (class in oml.interfaces.retrieval)
IExtractor (class in oml.interfaces.models)
IFreezable (class in oml.interfaces.models)
ILabeledDataset (class in oml.interfaces.datasets)
ImageBaseDataset (class in oml.datasets.images)
ImageLabeledDataset (class in oml.datasets.images)
ImagePairsDataset (class in oml.datasets.pairs)
ImageQueryGalleryDataset (class in oml.datasets.images)
ImageQueryGalleryLabeledDataset (class in oml.datasets.images)
IMetricDDP (class in oml.interfaces.metrics)
inference() (oml.retrieval.postprocessors.pairwise.PairwiseEmbeddingsPostprocessor method)
(oml.retrieval.postprocessors.pairwise.PairwiseImagesPostprocessor method)
(oml.retrieval.postprocessors.pairwise.PairwisePostprocessor method)
inverse_transform() (oml.utils.misc_torch.PCA method)
IPairsDataset (class in oml.interfaces.datasets)
IPairwiseModel (class in oml.interfaces.models)
IPipelineLogger (class in oml.interfaces.loggers)
IQueryGalleryDataset (class in oml.interfaces.datasets)
IQueryGalleryLabeledDataset (class in oml.interfaces.datasets)
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)
LinearTrivialDistanceSiamese (class in oml.models.meta.siamese)
log_figure() (oml.interfaces.loggers.IPipelineLogger method)
log_pipeline_info() (oml.interfaces.loggers.IPipelineLogger method)
M
mean (oml.utils.misc_torch.PCA attribute)
MetricValCallback (class in oml.lightning.callbacks.metric)
MetricValCallbackDDP (class in oml.lightning.callbacks.metric)
MinerWithBank (class in oml.miners.miner_with_bank)
ModuleDDP (class in oml.lightning.modules.ddp)
N
NHardTripletsMiner (class in oml.miners.inbatch_nhard_tri)
P
PairwiseEmbeddingsPostprocessor (class in oml.retrieval.postprocessors.pairwise)
PairwiseImagesPostprocessor (class in oml.retrieval.postprocessors.pairwise)
PairwisePostprocessor (class in oml.retrieval.postprocessors.pairwise)
patch_dataloader_to_ddp() (in module oml.ddp.patching)
PCA (class in oml.utils.misc_torch)
postprocessor_training_pipeline() (in module oml.lightning.pipelines.train_postprocessor)
predict() (oml.interfaces.models.IPairwiseModel method)
(oml.models.meta.siamese.ConcatSiamese method)
process() (oml.interfaces.retrieval.IDistancesPostprocessor method)
(oml.retrieval.postprocessors.pairwise.PairwisePostprocessor method)
R
ResnetExtractor (class in oml.models.resnet.extractor)
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)
(oml.metrics.embeddings.EmbeddingMetricsDDP method)
singular_values (oml.utils.misc_torch.PCA attribute)
SurrogatePrecision (class in oml.losses.surrogate_precision)
sync() (oml.interfaces.metrics.IMetricDDP method)
(oml.metrics.embeddings.EmbeddingMetricsDDP method)
sync_dicts_ddp() (in module oml.ddp.utils)
T
take_2d() (in module oml.utils.misc_torch)
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_data() (oml.interfaces.metrics.IBasicMetric method)
(oml.metrics.embeddings.EmbeddingMetrics method)
(oml.metrics.embeddings.EmbeddingMetricsDDP method)
V
visualize() (oml.datasets.images.ImageBaseDataset method)
(oml.datasets.images.ImageLabeledDataset method)
(oml.datasets.images.ImageQueryGalleryDataset method)
(oml.datasets.images.ImageQueryGalleryLabeledDataset method)
(oml.interfaces.datasets.IVisualizableDataset method)
(oml.metrics.embeddings.EmbeddingMetrics method)
ViTCLIPExtractor (class in oml.models.vit_clip.extractor)
ViTExtractor (class in oml.models.vit_dino.extractor)
Read the Docs
v: latest
Versions
latest
Downloads
pdf
On Read the Docs
Project Home
Builds