Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode
mmlearn 0.1.0b2 documentation
mmlearn 0.1.0b2 documentation
  • Installation
  • User Guide
  • Contributing to mmlearn
  • API Reference
    • mmlearn.conf package
    • mmlearn.datasets package
      • mmlearn.datasets.core package
        • mmlearn.datasets.core.combined_dataset module
        • mmlearn.datasets.core.data_collator module
        • mmlearn.datasets.core.example module
        • mmlearn.datasets.core.modalities module
        • mmlearn.datasets.core.samplers module
      • mmlearn.datasets.processors package
        • mmlearn.datasets.processors.masking module
        • mmlearn.datasets.processors.tokenizers module
        • mmlearn.datasets.processors.transforms module
      • mmlearn.datasets.chexpert module
      • mmlearn.datasets.imagenet module
      • mmlearn.datasets.librispeech module
      • mmlearn.datasets.llvip module
      • mmlearn.datasets.nihcxr module
      • mmlearn.datasets.nyuv2 module
      • mmlearn.datasets.sunrgbd module
    • mmlearn.hf_utils module
    • mmlearn.modules package
      • mmlearn.modules.encoders package
        • mmlearn.modules.encoders.clip module
        • mmlearn.modules.encoders.text module
        • mmlearn.modules.encoders.vision module
      • mmlearn.modules.layers package
        • mmlearn.modules.layers.attention module
        • mmlearn.modules.layers.embedding module
        • mmlearn.modules.layers.logit_scaling module
        • mmlearn.modules.layers.mlp module
        • mmlearn.modules.layers.normalization module
        • mmlearn.modules.layers.patch_dropout module
        • mmlearn.modules.layers.transformer_block module
      • mmlearn.modules.losses package
        • mmlearn.modules.losses.contrastive module
        • mmlearn.modules.losses.data2vec module
      • mmlearn.modules.lr_schedulers package
        • mmlearn.modules.lr_schedulers.linear_warmup_cosine_lr module
      • mmlearn.modules.metrics package
        • mmlearn.modules.metrics.retrieval_recall module
      • mmlearn.modules.ema module
    • mmlearn.tasks package
      • mmlearn.tasks.base module
      • mmlearn.tasks.contrastive_pretraining module
      • mmlearn.tasks.hooks module
      • mmlearn.tasks.ijepa module
      • mmlearn.tasks.zero_shot_classification module
      • mmlearn.tasks.zero_shot_retrieval module
Back to top

mmlearn.modules.metrics package¶

Metrics for evaluating models.

Submodules¶

  • mmlearn.modules.metrics.retrieval_recall module
    • RetrievalRecallAtK
      • RetrievalRecallAtK.__init__()
      • RetrievalRecallAtK.compute()
      • RetrievalRecallAtK.forward()
      • RetrievalRecallAtK.full_state_update
      • RetrievalRecallAtK.higher_is_better
      • RetrievalRecallAtK.indexes
      • RetrievalRecallAtK.is_differentiable
      • RetrievalRecallAtK.num_samples
      • RetrievalRecallAtK.update()
      • RetrievalRecallAtK.x
      • RetrievalRecallAtK.y
Next
mmlearn.modules.metrics.retrieval_recall module
Previous
mmlearn.modules.lr_schedulers.linear_warmup_cosine_lr module
Copyright © 2024, Vector AI Engineering
Logo of the Vector Institute
On this page
  • mmlearn.modules.metrics package
    • Submodules