Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Mapping Networks 0.1.0 documentation
Mapping Networks 0.1.0 documentation

Getting Started

  • Installation
  • Quickstart

User Guides

  • Paper and design correspondence
  • Parameter runtime
  • Stateless target execution
  • Mappers and modulation
  • Generators and strategies
  • MappingModel guide
  • Loss system
  • Configuration and registries
  • Trainer and callbacks
  • Checkpointing and Resumption
  • Scaling and Distributed Execution
  • Development and compatibility
  • Extension recipes

API Reference

  • Models
    • mapping_networks.models.MappingModel
    • mapping_networks.models.TargetModel
    • mapping_networks.models.ForwardResult
    • mapping_networks.models.UnsupportedTargetModelError
  • Losses
    • mapping_networks.losses.MappingLoss
    • mapping_networks.losses.BaseLoss
    • mapping_networks.losses.LossOutput
    • mapping_networks.losses.TrainingContext
    • mapping_networks.losses.AlignmentLoss
    • mapping_networks.losses.SmoothnessLoss
    • mapping_networks.losses.StabilityLoss
    • mapping_networks.losses.TaskLoss
    • mapping_networks.losses.ClassificationLoss
    • mapping_networks.losses.RegressionLoss
  • Trainers
    • mapping_networks.trainers.MappingTrainer
    • mapping_networks.trainers.BatchAdapter
    • mapping_networks.trainers.MappingBatchAdapter
    • mapping_networks.trainers.TupleBatchAdapter
  • Mappers
    • mapping_networks.mappers.BaseMapper
    • mapping_networks.mappers.MLPMapper
    • mapping_networks.mappers.ResidualMLPMapper
  • Modulation
    • mapping_networks.modulation.BaseModulation
    • mapping_networks.modulation.AdditiveModulation
    • mapping_networks.modulation.AffineModulation
    • mapping_networks.modulation.LowRankModulation
  • Generators
    • mapping_networks.generators.ParameterGenerator
    • mapping_networks.generators.LayerGenerator
    • mapping_networks.generators.LayerwiseGenerator
    • mapping_networks.generators.LazyLayerwiseGenerator
    • mapping_networks.generators.SingleVectorGenerator
    • mapping_networks.generators.GroupedGenerator
  • Strategies
    • mapping_networks.strategies.GenerationStrategy
    • mapping_networks.strategies.GroupedStrategy
    • mapping_networks.strategies.LayerwiseStrategy
    • mapping_networks.strategies.SLVTStrategy
  • Runtime
    • mapping_networks.runtime.ParameterEntry
    • mapping_networks.runtime.ParameterSpec
    • mapping_networks.runtime.ParameterTree
    • mapping_networks.runtime.clone_module_buffers
    • mapping_networks.runtime.functional_forward
  • Config
    • mapping_networks.config.GeneratorConfig
    • mapping_networks.config.LossConfig
    • mapping_networks.config.MapperConfig
    • mapping_networks.config.MappingConfig
    • mapping_networks.config.TaskLossConfig
    • mapping_networks.config.TrainerConfig
    • mapping_networks.config.load_config
  • Registry
    • mapping_networks.registry.Registry
    • mapping_networks.registry.MAPPER_REGISTRY
    • mapping_networks.registry.MODULATION_REGISTRY
    • mapping_networks.registry.GENERATOR_REGISTRY
    • mapping_networks.registry.LOSS_REGISTRY
  • Callbacks
    • mapping_networks.callbacks.Callback
    • mapping_networks.callbacks.EarlyStopping
    • mapping_networks.callbacks.MetricLogger
  • Checkpointing
    • mapping_networks.checkpoint.save_checkpoint
    • mapping_networks.checkpoint.load_checkpoint
    • mapping_networks.checkpoint.CheckpointSchema
    • mapping_networks.checkpoint.CheckpointCompatibilityError
  • Distributed & Memory
    • mapping_networks.distributed.is_ddp_available
    • mapping_networks.distributed.setup_ddp
    • mapping_networks.distributed.cleanup_ddp
    • mapping_networks.distributed.wrap_ddp
    • mapping_networks.distributed.profile_peak_memory
    • mapping_networks.distributed.benchmark_strategies
Back to top
View this page

CheckpointingΒΆ

save_checkpoint

Save a compact, versioned checkpoint for the mapping network.

load_checkpoint

Load a checkpoint and restore model (and optionally trainer) state.

CheckpointSchema

All fields written to / read from a checkpoint file.

CheckpointCompatibilityError

Raised when a checkpoint's architecture is incompatible with the model.

Next
mapping_networks.checkpoint.save_checkpoint
Previous
mapping_networks.callbacks.MetricLogger
Copyright © 2026, Arjun Manjunath
Made with Sphinx and @pradyunsg's Furo