Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
ClinicaDL
Light Logo Dark Logo
ClinicaDL
  • Quickstart
  • Installation
  • User Guide
    • 1. Manipulating neuroimaging data
      • 1.1. Data structures
      • 1.2. Reading neuroimaging datasets
        • 1.2.1. Reading BIDS datasets
        • 1.2.2. Reading neuroimaging datasets: advanced tips
      • 1.3. Transforming data
      • 1.4. Splitting data
      • 1.5. Batching data for training
    • 2. Building a deep learning workflow
      • 2.1. Defining a model
      • 2.2. Training
      • 2.3. Evaluating
      • 2.4. Callbacks
    • 3. Experiment management and reproducibility
      • 3.1. Configuration classes
      • 3.2. MAPS
    • 4. Customising your ClinicaDL experiment
  • API Reference
    • clinicadl.callbacks
      • clinicadl.callbacks.CallbacksHandler
      • clinicadl.callbacks.Callback
      • clinicadl.callbacks.EarlyStoppingCallback
      • clinicadl.callbacks.LoggerCallback
      • clinicadl.callbacks.LRSchedulerCallback
      • clinicadl.callbacks.ModelCheckpointCallback
      • clinicadl.callbacks.MonitorCallback
      • clinicadl.callbacks.TrainingCheckpointCallback
    • clinicadl.data
      • clinicadl.data.datasets
        • clinicadl.data.datasets.Dataset
        • clinicadl.data.datasets.BidsDataset
        • clinicadl.data.datasets.TensorDataset
        • clinicadl.data.datasets.ConcatDataset
        • clinicadl.data.datasets.PairedDataset
        • clinicadl.data.datasets.UnpairedDataset
        • clinicadl.data.datasets.examples.BidsStroke
        • clinicadl.data.datasets.examples.BidsStrokeSmall
        • clinicadl.data.datasets.examples.BidsDLBS
        • clinicadl.data.datasets.examples.BidsDLBSSmall
        • clinicadl.data.datasets.examples.CapsDLBS
        • clinicadl.data.datasets.examples.BidsNeuroEmo
      • clinicadl.data.dataloader
        • clinicadl.data.dataloader.Batch
        • clinicadl.data.dataloader.DataLoader
        • clinicadl.data.dataloader.collate.CollateFn
        • clinicadl.data.dataloader.collate.ToBatchCollate
        • clinicadl.data.dataloader.collate.ToBatchesCollate
        • clinicadl.data.dataloader.collate.MergeBatchesCollate
      • clinicadl.data.structures
        • clinicadl.data.structures.DataPoint
        • clinicadl.data.structures.Sample
        • clinicadl.data.structures.Sample2D
        • clinicadl.data.structures.examples.Colin27DataPoint
        • clinicadl.data.structures.examples.Colin27Sample
        • clinicadl.data.structures.examples.Colin27Sample2D
      • clinicadl.data.utils
        • clinicadl.data.utils.remove_tensors
    • clinicadl.infer
      • clinicadl.infer.Inferer
      • clinicadl.infer.SimpleInferer
      • clinicadl.infer.SlicesToImageInferer
      • clinicadl.infer.PatchesToImageInferer
    • clinicadl.io
      • clinicadl.io.bids
        • clinicadl.io.bids.Bids
        • clinicadl.io.bids.BidsFileType
        • clinicadl.io.bids.T1Linear
        • clinicadl.io.bids.FlairLinear
        • clinicadl.io.bids.PetLinear
        • clinicadl.io.bids.DwiDti
      • clinicadl.io.maps
        • clinicadl.io.maps.Maps
    • clinicadl.losses
      • clinicadl.losses.config.BCELossConfig
      • clinicadl.losses.config.BCEWithLogitsLossConfig
      • clinicadl.losses.config.CrossEntropyLossConfig
      • clinicadl.losses.config.NLLLossConfig
      • clinicadl.losses.config.MultiMarginLossConfig
      • clinicadl.losses.config.MSELossConfig
      • clinicadl.losses.config.L1LossConfig
      • clinicadl.losses.config.SmoothL1LossConfig
      • clinicadl.losses.config.HuberLossConfig
      • clinicadl.losses.config.KLDivLossConfig
      • clinicadl.losses.config.DiceLossConfig
      • clinicadl.losses.config.DiceCELossConfig
      • clinicadl.losses.config.DiceFocalLossConfig
      • clinicadl.losses.config.GeneralizedDiceLossConfig
      • clinicadl.losses.config.GeneralizedDiceFocalLossConfig
      • clinicadl.losses.config.FocalLossConfig
      • clinicadl.losses.config.TverskyLossConfig
      • clinicadl.losses.config.SoftclDiceLossConfig
      • clinicadl.losses.config.SSIMLossConfig
    • clinicadl.metrics
      • clinicadl.metrics.Metric
      • clinicadl.metrics.MetricsHandler
      • clinicadl.metrics.config
        • clinicadl.metrics.config.LossMetricConfig
        • clinicadl.metrics.config.ConfusionMatrixMetricConfig
        • clinicadl.metrics.config.ROCAUCMetricConfig
        • clinicadl.metrics.config.AveragePrecisionMetricConfig
        • clinicadl.metrics.config.MSEMetricConfig
        • clinicadl.metrics.config.MAEMetricConfig
        • clinicadl.metrics.config.RMSEMetricConfig
        • clinicadl.metrics.config.PSNRMetricConfig
        • clinicadl.metrics.config.SSIMMetricConfig
        • clinicadl.metrics.config.MultiScaleSSIMMetricConfig
        • clinicadl.metrics.config.MeanIoUConfig
        • clinicadl.metrics.config.DiceMetricConfig
        • clinicadl.metrics.config.GeneralizedDiceScoreConfig
        • clinicadl.metrics.config.SurfaceDiceMetricConfig
        • clinicadl.metrics.config.SurfaceDistanceMetricConfig
        • clinicadl.metrics.config.HausdorffDistanceMetricConfig
    • clinicadl.models
      • clinicadl.models.Model
      • clinicadl.models.SupervisedModel
      • clinicadl.models.ReconstructionModel
    • clinicadl.networks
      • clinicadl.networks.nn
        • clinicadl.networks.nn.MLP
        • clinicadl.networks.nn.ConvEncoder
        • clinicadl.networks.nn.ConvDecoder
        • clinicadl.networks.nn.CNN
        • clinicadl.networks.nn.Generator
        • clinicadl.networks.nn.AutoEncoder
        • clinicadl.networks.nn.VAE
        • clinicadl.networks.nn.UNet
        • clinicadl.networks.nn.AttentionUNet
        • clinicadl.networks.nn.DenseNet
        • clinicadl.networks.nn.ResNet
        • clinicadl.networks.nn.SEResNet
        • clinicadl.networks.nn.ViT
        • clinicadl.networks.nn.DenseNet121
        • clinicadl.networks.nn.DenseNet161
        • clinicadl.networks.nn.DenseNet169
        • clinicadl.networks.nn.DenseNet201
        • clinicadl.networks.nn.ResNet18
        • clinicadl.networks.nn.ResNet34
        • clinicadl.networks.nn.ResNet50
        • clinicadl.networks.nn.ResNet101
        • clinicadl.networks.nn.ResNet152
        • clinicadl.networks.nn.SEResNet50
        • clinicadl.networks.nn.SEResNet101
        • clinicadl.networks.nn.SEResNet152
        • clinicadl.networks.nn.ViTB16
        • clinicadl.networks.nn.ViTB32
        • clinicadl.networks.nn.ViTL16
        • clinicadl.networks.nn.ViTL32
      • clinicadl.networks.config
        • clinicadl.networks.config.MLPConfig
        • clinicadl.networks.config.ConvEncoderConfig
        • clinicadl.networks.config.ConvDecoderConfig
        • clinicadl.networks.config.CNNConfig
        • clinicadl.networks.config.GeneratorConfig
        • clinicadl.networks.config.AutoEncoderConfig
        • clinicadl.networks.config.VAEConfig
        • clinicadl.networks.config.MLPOptions
        • clinicadl.networks.config.ConvEncoderOptions
        • clinicadl.networks.config.ConvDecoderOptions
        • clinicadl.networks.config.UNetConfig
        • clinicadl.networks.config.AttentionUNetConfig
        • clinicadl.networks.config.DenseNetConfig
        • clinicadl.networks.config.ResNetConfig
        • clinicadl.networks.config.SEResNetConfig
        • clinicadl.networks.config.ViTConfig
        • clinicadl.networks.config.DenseNet121Config
        • clinicadl.networks.config.DenseNet161Config
        • clinicadl.networks.config.DenseNet169Config
        • clinicadl.networks.config.DenseNet201Config
        • clinicadl.networks.config.ResNet18Config
        • clinicadl.networks.config.ResNet34Config
        • clinicadl.networks.config.ResNet50Config
        • clinicadl.networks.config.ResNet101Config
        • clinicadl.networks.config.ResNet152Config
        • clinicadl.networks.config.SEResNet50Config
        • clinicadl.networks.config.SEResNet101Config
        • clinicadl.networks.config.SEResNet152Config
        • clinicadl.networks.config.ViTB16Config
        • clinicadl.networks.config.ViTB32Config
        • clinicadl.networks.config.ViTL16Config
        • clinicadl.networks.config.ViTL32Config
    • clinicadl.optim
      • clinicadl.optim.OptimizationConfig
      • clinicadl.optim.optimizers.config
        • clinicadl.optim.optimizers.config.AdadeltaConfig
        • clinicadl.optim.optimizers.config.AdagradConfig
        • clinicadl.optim.optimizers.config.AdamConfig
        • clinicadl.optim.optimizers.config.RMSpropConfig
        • clinicadl.optim.optimizers.config.SGDConfig
      • clinicadl.optim.lr_schedulers.config
        • clinicadl.optim.lr_schedulers.config.ConstantLRConfig
        • clinicadl.optim.lr_schedulers.config.ExponentialLRConfig
        • clinicadl.optim.lr_schedulers.config.LinearLRConfig
        • clinicadl.optim.lr_schedulers.config.StepLRConfig
        • clinicadl.optim.lr_schedulers.config.MultiStepLRConfig
        • clinicadl.optim.lr_schedulers.config.PolynomialLRConfig
        • clinicadl.optim.lr_schedulers.config.ReduceLROnPlateauConfig
        • clinicadl.optim.lr_schedulers.config.OneCycleLRConfig
    • clinicadl.split
      • clinicadl.split.make_split
      • clinicadl.split.make_kfold
      • clinicadl.split.SingleSplit
      • clinicadl.split.KFold
      • clinicadl.split.Split
    • clinicadl.transforms
      • clinicadl.transforms.TransformsHandler
      • clinicadl.transforms.MergeFields
      • clinicadl.transforms.Format
      • clinicadl.transforms.extraction
        • clinicadl.transforms.extraction.Image
        • clinicadl.transforms.extraction.Patch
        • clinicadl.transforms.extraction.Slice
      • clinicadl.transforms.config
        • clinicadl.transforms.config.RescaleIntensityConfig
        • clinicadl.transforms.config.ZNormalizationConfig
        • clinicadl.transforms.config.MaskConfig
        • clinicadl.transforms.config.ClampConfig
        • clinicadl.transforms.config.CropOrPadConfig
        • clinicadl.transforms.config.ToCanonicalConfig
        • clinicadl.transforms.config.ResizeConfig
        • clinicadl.transforms.config.ResampleConfig
        • clinicadl.transforms.config.EnsureShapeMultipleConfig
        • clinicadl.transforms.config.CropConfig
        • clinicadl.transforms.config.PadConfig
        • clinicadl.transforms.config.RemapLabelsConfig
        • clinicadl.transforms.config.OneHotConfig
        • clinicadl.transforms.config.MergeFieldsConfig
        • clinicadl.transforms.config.OneOfConfig
        • clinicadl.transforms.config.RandomMotionConfig
        • clinicadl.transforms.config.RandomGhostingConfig
        • clinicadl.transforms.config.RandomSpikeConfig
        • clinicadl.transforms.config.RandomBiasFieldConfig
        • clinicadl.transforms.config.RandomBlurConfig
        • clinicadl.transforms.config.RandomNoiseConfig
        • clinicadl.transforms.config.RandomSwapConfig
        • clinicadl.transforms.config.RandomGammaConfig
        • clinicadl.transforms.config.RandomFlipConfig
        • clinicadl.transforms.config.RandomAffineConfig
        • clinicadl.transforms.config.RandomElasticDeformationConfig
        • clinicadl.transforms.config.RandomAnisotropyConfig
        • clinicadl.transforms.config.ActivationsConfig
        • clinicadl.transforms.config.AsDiscreteConfig
        • clinicadl.transforms.config.KeepLargestConnectedComponentConfig
        • clinicadl.transforms.config.DistanceTransformEDTConfig
        • clinicadl.transforms.config.RemoveSmallObjectsConfig
        • clinicadl.transforms.config.LabelFilterConfig
        • clinicadl.transforms.config.FillHolesConfig
        • clinicadl.transforms.config.SobelGradientsConfig
        • clinicadl.transforms.config.FormatConfig
    • clinicadl.train
      • clinicadl.train.Trainer
      • clinicadl.train.TrainerState
      • clinicadl.train.ComputationalConfig
    • clinicadl.utils
      • clinicadl.utils.seed.seed_everything
      • clinicadl.utils.seed.seed_everything_context
  • Glossary
  • Examples
    • An example
    • A section
      • Another example
  • Tutorials
    • An example

development

  • Contributing
  • What’s new?
    • 2.0.0
    • 1.6.1
    • 1.6.0
    • 1.5.1
    • 1.5.0
    • 1.4.0
    • 1.3.1
    • 1.3.0
    • 1.2.0
    • 1.1.1
    • 1.1.0
    • 1.0.4
    • 1.0.3
    • 1.0.2
    • 1.0.1
    • 1.0
    • 0.2.2
    • 0.2.1
    • 0.2.0
  • GitHub
Back to top

Examples¶

An example

An example

A section¶

Another example

Another example

Gallery generated by Sphinx-Gallery

Next
An example
Previous
Glossary
Copyright © 2026, ARAMIS Lab
Made with Sphinx and @pradyunsg's Furo
On this page
  • Examples
    • A section