Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content

This is the development documentation of nidl (0.0.1)

Nidl
Logo
Nidl
  • Quickstart
  • Examples
    • Decoupled Contrastive Learning
    • How to use NIDL with Hydra
    • Model probing of embedding estimators
    • Presentation of the OpenBHB dataset
    • Self-Supervised Contrastive Learning with SimCLR on MNIST
    • Self-Supervised Learning with Barlow Twins
    • Self-Supervised Learning with I-JEPA on MedMNIST3D
    • Visualization of metrics during training of PyTorch-Lightning models
    • Weakly Supervised Contrastive Learning with y-Aware
  • User guide
    • 1. Introduction
    • 2. What is nidl?
    • 3. Using nidl for the first time
    • 4. Applications to Neuroimaging
    • 5. Supervised Learning
    • 6. Self Supervised Learning
    • 7. Auto Encoders
    • 8. Model Probing
    • 9. Data Augmentation
    • 10. Pretrained Models
    • 11. Architectures
      • 11.1. Volume
      • 11.2. Surface
    • 12. Open Datasets
  • API References
    • nidl.estimators: Available estimators
      • nidl.estimators.BaseEstimator
      • nidl.estimators.ClassifierMixin
      • nidl.estimators.ClusterMixin
      • nidl.estimators.RegressorMixin
      • nidl.estimators.TransformerMixin
      • nidl.estimators.ssl.SimCLR
      • nidl.estimators.ssl.DCL
      • nidl.estimators.ssl.YAwareContrastiveLearning
      • nidl.estimators.ssl.BarlowTwins
      • nidl.estimators.ssl.DINO
      • nidl.estimators.ssl.IJEPA
      • nidl.estimators.ssl.NeuroJEPA
      • nidl.estimators.probes.ModelProbing
      • nidl.estimators.autoencoders.VAE
      • nidl.estimators.dummy.DummyEmbeddingEstimator
    • nidl.losses: Available losses
      • nidl.losses.InfoNCE
      • nidl.losses.DCLLoss
      • nidl.losses.DCLWLoss
      • nidl.losses.YAwareInfoNCE
      • nidl.losses.BarlowTwinsLoss
      • nidl.losses.DINOLoss
      • nidl.losses.BetaVAELoss
    • nidl.estimators.ssl.utils: Available projection heads
      • nidl.estimators.ssl.utils.ProjectionHead
      • nidl.estimators.ssl.utils.SimCLRProjectionHead
      • nidl.estimators.ssl.utils.YAwareProjectionHead
      • nidl.estimators.ssl.utils.BarlowTwinsProjectionHead
      • nidl.estimators.ssl.utils.DINOProjectionHead
    • nidl.backbones.volume: Available backbones
      • nidl.utils.weights.Weights
      • nidl.backbones.volume.AlexNet
      • nidl.backbones.volume.DenseNet
      • nidl.backbones.volume.ResNet
      • nidl.backbones.volume.ResNetTruncated
      • nidl.backbones.volume.VisionTransformer3D
      • nidl.backbones.volume.VisionTransformer3DMoE
      • nidl.backbones.volume.MoEParams
      • nidl.backbones.volume.densenet121
      • nidl.backbones.volume.resnet18_trunc
      • nidl.backbones.volume.resnet50
      • nidl.backbones.volume.resnet50_trunc
      • nidl.backbones.volume.vit_small_patch16_128
      • nidl.backbones.volume.vit_base_patch16_128
      • nidl.backbones.volume.vit_large_patch16_128
    • nidl.transforms.transforms: Available transformations
      • nidl.transforms.transforms.Transform
      • nidl.transforms.transforms.Identity
      • nidl.transforms.transforms.MultiViewsTransform
      • nidl.transforms.transforms.VolumeTransform
      • nidl.transforms.volume.preprocessing.RobustRescaling
      • nidl.transforms.volume.preprocessing.ZNormalization
      • nidl.transforms.volume.preprocessing.CropOrPad
      • nidl.transforms.volume.preprocessing.Resample
      • nidl.transforms.volume.preprocessing.Resize
      • nidl.transforms.volume.augmentation.RandomGaussianBlur
      • nidl.transforms.volume.augmentation.RandomGaussianNoise
      • nidl.transforms.volume.augmentation.RandomErasing
      • nidl.transforms.volume.augmentation.RandomFlip
      • nidl.transforms.volume.augmentation.RandomResizedCrop
      • nidl.transforms.volume.augmentation.RandomRotation
    • nidl.datasets: Available datasets
      • nidl.datasets.BaseImageDataset
      • nidl.datasets.BaseNumpyDataset
      • nidl.datasets.ImageDataFrameDataset
      • nidl.datasets.OpenBHB
    • nidl.callbacks: Available callbacks
      • nidl.callbacks.ModelProbingCallback
      • nidl.callbacks.ModelProbingCVCallback
      • nidl.callbacks.MetricsCallback
      • nidl.callbacks.BatchTypingCallback
    • nidl.metrics: Available metrics
      • nidl.metrics.pearson_r
      • nidl.metrics.alignment_score
      • nidl.metrics.uniformity_score
      • nidl.metrics.contrastive_accuracy_score
      • nidl.metrics.procrustes_similarity
      • nidl.metrics.procrustes_r2
      • nidl.metrics.kruskal_similarity
  • Glossary

Development

  • Contributing
  • Continuous integration
  • Maintenance
  • Changelog
  • Team
  • Versions
  • GitHub Repository
Back to top
View this page
Edit this page

API ReferencesΒΆ

This is the class and function reference of nidl. Please refer to the user guide for more information and usage examples.

  • nidl.estimators: Available estimators
  • nidl.losses: Available losses
  • nidl.estimators.ssl.utils: Available projection heads
  • nidl.backbones.volume: Available backbones
  • nidl.transforms.transforms: Available transformations
  • nidl.datasets: Available datasets
  • nidl.callbacks: Available callbacks
  • nidl.metrics: Available metrics
Next
nidl.estimators: Available estimators
Previous
12. Open Datasets
Copyright © The nidl developers - Code and documentation distributed under CeCILL-B license.
Made with Sphinx and @pradyunsg's Furo