Skip to main content
Ctrl+K

ALCHEMI Toolkit

  • User Guide
  • Supported Models
  • Examples
  • API
  • Changelog
  • Github
  • User Guide
  • Supported Models
  • Examples
  • API
  • Changelog
  • Github

Section Navigation

Modules

  • Data module (AtomicData, Batch, readers/writers)
    • nvalchemi.data.AtomicData
    • nvalchemi.data.Batch
    • nvalchemi.data.LevelSchema
    • nvalchemi.data.resolve_device
    • nvalchemi.data.transforms.Compose
    • nvalchemi.data.transforms.make_supercell
    • nvalchemi.data.AtomicDataZarrWriter
    • nvalchemi.data.AtomicDataZarrReader
    • nvalchemi.data.FieldSchema
    • nvalchemi.data.Dataset
    • nvalchemi.data.InMemoryDataset
    • nvalchemi.data.DataLoader
    • nvalchemi.data.Reader
    • nvalchemi.data.datapipes.MultiDataset
    • nvalchemi.data.datapipes.MultiDatasetSampler
    • nvalchemi.data.datapipes.MultiDatasetBatchSampler
    • nvalchemi.data.datapipes.distributed_shard
    • nvalchemi.data.datapipes.dataset_device
    • nvalchemi.data.datapipes.same_device
    • nvalchemi.data.datapipes.ZarrArrayConfig
    • nvalchemi.data.datapipes.ZarrWriteConfig
  • Hooks — Core Framework
    • nvalchemi.hooks.Hook
    • nvalchemi.hooks.CheckpointableHook
    • nvalchemi.hooks.HookContext
    • nvalchemi.hooks.DynamicsContext
    • nvalchemi.hooks.GenerationContext
    • nvalchemi.hooks.TrainContext
    • nvalchemi.hooks.HookRegistryMixin
    • nvalchemi.hooks.BiasedPotentialHook
    • nvalchemi.hooks.NeighborListHook
    • nvalchemi.hooks.StageTimingHook
    • nvalchemi.hooks.TorchProfilerHook
    • nvalchemi.hooks.WrapPeriodicHook
    • nvalchemi.hooks.Reporter
    • nvalchemi.hooks.ReportingOrchestrator
    • nvalchemi.hooks.ReportingState
    • nvalchemi.hooks.ScalarSnapshot
    • nvalchemi.hooks.collect_scalars
    • nvalchemi.hooks.TensorBoardReporter
    • nvalchemi.hooks.RichReporter
    • nvalchemi.hooks.RichLayout
    • nvalchemi.hooks.BaseRichLayout
    • nvalchemi.hooks.TrainingRichLayout
    • nvalchemi.hooks.DynamicsRichLayout
  • Dynamics module
    • Architecture Overview
    • Dynamics Hooks — Stages & Usage
      • nvalchemi.dynamics.hooks.LoggingHook
      • nvalchemi.dynamics.hooks.SnapshotHook
      • nvalchemi.dynamics.hooks.ConvergedSnapshotHook
      • nvalchemi.dynamics.hooks.EnergyDriftMonitorHook
      • nvalchemi.dynamics.hooks.StabilityMonitor
      • nvalchemi.dynamics.hooks.StabilityMetrics
      • nvalchemi.dynamics.hooks.total_momentum
      • nvalchemi.dynamics.hooks.NaNDetectorHook
      • nvalchemi.dynamics.hooks.MaxForceClampHook
      • nvalchemi.dynamics.hooks.nonfinite_graph_mask
      • nvalchemi.dynamics.hooks.FreezeAtomsHook
      • nvalchemi.dynamics.hooks.PairSwapHook
      • nvalchemi.dynamics.hooks.kinetic_energy_per_graph
    • Convergence Criteria
    • FusedStage — Single-GPU Orchestration
    • DistributedPipeline — Multi-GPU Workflows
    • Buffers & Data Flow
      • nvalchemi.dynamics.base.BufferConfig
    • Implementing Custom Dynamics
    • Reaction Paths and NEB
      • nvalchemi.dynamics.mep.NEB
      • nvalchemi.dynamics.mep.ClimbingImageConfig
      • nvalchemi.dynamics.mep.interpolate_paths
      • nvalchemi.dynamics.mep.IDPPModel
      • nvalchemi.dynamics.mep.prepare_idpp_targets
      • nvalchemi.dynamics.mep.validate_paths
      • nvalchemi.dynamics.mep.align_batch_positions
      • nvalchemi.dynamics.mep.NEBMethod
      • nvalchemi.dynamics.mep.TorchNEBMethod
      • nvalchemi.dynamics.mep.SpringConfig
      • nvalchemi.dynamics.mep.ConstantSpringConfig
      • nvalchemi.dynamics.mep.SpringContext
      • nvalchemi.dynamics.mep.hooks.PathEnergyStatsHook
      • nvalchemi.dynamics.mep.hooks.PathEnergyStats
      • nvalchemi.dynamics.mep.hooks.PathDiagnosticsHook
      • nvalchemi.dynamics.mep.hooks.PathDiagnostics
      • nvalchemi.dynamics.mep.hooks.NEBForceHook
      • nvalchemi.dynamics.mep.hooks.ClimbingImageSelectionHook
    • API Reference
      • nvalchemi.dynamics.BaseDynamics
      • nvalchemi.dynamics.DynamicsStrategy
      • nvalchemi.dynamics.DemoDynamics
      • nvalchemi.dynamics.FusedStage
      • nvalchemi.dynamics.DistributedPipeline
      • nvalchemi.dynamics.DynamicsStage
      • nvalchemi.dynamics.ConvergenceHook
      • nvalchemi.dynamics.KB_EV
      • nvalchemi.dynamics.NVE
      • nvalchemi.dynamics.NVTLangevin
      • nvalchemi.dynamics.NVTNoseHoover
      • nvalchemi.dynamics.NPT
      • nvalchemi.dynamics.NPH
      • nvalchemi.dynamics.FIRE2
      • nvalchemi.dynamics.FIRE2VariableCell
      • nvalchemi.dynamics.LBFGS
      • nvalchemi.dynamics.LBFGSVariableCell
      • nvalchemi.dynamics.DataSink
      • nvalchemi.dynamics.ResizableSink
      • nvalchemi.dynamics.GPUBuffer
      • nvalchemi.dynamics.HostMemory
      • nvalchemi.dynamics.ZarrData
      • nvalchemi.dynamics.SizeAwareSampler
      • nvalchemi.dynamics.OrderedStructureSampler
      • nvalchemi.dynamics.StructureSource
      • nvalchemi.dynamics.FitPolicy
      • nvalchemi.dynamics.WithinBudget
    • Integrator Algorithms
  • Models module (BaseModelMixin, ModelConfig, wrappers)
    • nvalchemi.models.base.ModelConfig
    • nvalchemi.models.base.NeighborConfig
    • nvalchemi.models.base.BaseModelMixin
    • nvalchemi.models.HessianOperator
    • nvalchemi.models.demo.DemoModel
    • nvalchemi.models.demo.DemoModelWrapper
    • nvalchemi.models.mace.MACEWrapper
    • nvalchemi.models.aimnet2.AIMNet2Wrapper
    • nvalchemi.models.uma.UMAWrapper
    • nvalchemi.models.lj.LennardJonesModelWrapper
    • nvalchemi.models.dftd3.DFTD3ModelWrapper
    • nvalchemi.models.ewald.EwaldModelWrapper
    • nvalchemi.models.pme.PMEModelWrapper
    • nvalchemi.models.pipeline.PipelineModelWrapper
    • nvalchemi.models.pipeline.PipelineStep
    • nvalchemi.models.pipeline.PipelineGroup
  • Generative module (AtomisticGenerator, hooks, pipelines)
    • nvalchemi.gen.AtomisticGenerator
    • nvalchemi.gen.GeneratingFunction
    • nvalchemi.gen.ConditionFunction
    • nvalchemi.gen.GenerationStage
    • nvalchemi.gen.GenerationContext
    • nvalchemi.gen.GenerationPipeline
    • nvalchemi.models.gen.GenerativeModelConfig
    • nvalchemi.models.gen.GenerativeModelMixin
    • nvalchemi.models.gen.demo.DemoGANModel
    • nvalchemi.models.gen.demo.DemoDiffusionModel
  • Training module
    • Training checkpoints
      • nvalchemi.training.TrainingStrategy.save_checkpoint
      • nvalchemi.training.TrainingStrategy.restore_checkpoint
      • nvalchemi.training.TrainingStrategy.load_checkpoint
      • nvalchemi.training.save_checkpoint
      • nvalchemi.training.load_checkpoint
      • nvalchemi.training.hooks.CheckpointHook
    • Training strategy API
      • nvalchemi.training.TrainingStrategy
      • nvalchemi.training.default_training_fn
      • nvalchemi.training.OptimizerConfig
      • nvalchemi.training.setup_optimizers
      • nvalchemi.training.zero_gradients
      • nvalchemi.training.step_optimizers
      • nvalchemi.training.step_lr_schedulers
      • nvalchemi.training.BaseSpec
      • nvalchemi.training.create_model_spec
      • nvalchemi.training.create_model_spec_from_json
      • nvalchemi.training.register_type_serializer
      • nvalchemi.training.CheckpointManifest
      • nvalchemi.training.save_checkpoint
      • nvalchemi.training.load_checkpoint
      • nvalchemi.training.configure_dataloader
      • nvalchemi.training.configure_parallelism
      • nvalchemi.training.move_to_devices
      • nvalchemi.training.rehome_optimizer_state
      • nvalchemi.training.freeze_unconfigured_models
      • nvalchemi.training.eval_configured_models
      • nvalchemi.training.evaluating
      • nvalchemi.training.unwrap_model
      • nvalchemi.training.distributed.all_reduce_flags
      • nvalchemi.training.distributed.all_gather_rows
      • nvalchemi.training.distributed.all_gather_objects
    • Fine-tuning API
      • nvalchemi.training.FineTuningStrategy
      • nvalchemi.training.FineTuningStrategy.from_pretrained_checkpoint
      • nvalchemi.training.hooks.ModulePatchHook
      • nvalchemi.training.hooks.TrainableParameterHook
      • nvalchemi.training.hooks.FineTuningSummaryHook
      • nvalchemi.training.hooks.BaseFingerprintHook
      • nvalchemi.training.peft.lora_hook.LoRAHook
      • nvalchemi.training.peft.PeftMethodRegistration
      • nvalchemi.training.peft.register_peft_method
      • nvalchemi.training.peft.available_peft_methods
      • nvalchemi.training.peft.load_peft_checkpoint_into_model
      • nvalchemi.training.peft.lora.LoRAConfig
      • nvalchemi.training.peft.lora.available_lora_wrappers
    • Distillation API
      • nvalchemi.training.distillation.TeacherScorer
      • nvalchemi.training.distillation.InProcessTeacherScorer
      • nvalchemi.training.distillation.TeacherSignal
      • nvalchemi.training.distillation.signal_fields
      • nvalchemi.training.distillation.scorer_fields
      • nvalchemi.training.distillation.signal_for_field
      • nvalchemi.training.distillation.SignalLevel
      • nvalchemi.training.distillation.SignalNormalizer
      • nvalchemi.training.distillation.NeighborListPolicy
      • nvalchemi.training.distillation.label_dataset
      • nvalchemi.training.distillation.DistillationStrategy
      • nvalchemi.training.distillation.default_distillation_fn
      • nvalchemi.training.distillation.embedding_distillation_fn
      • nvalchemi.training.distillation.hessian_distillation_fn
      • nvalchemi.training.distillation.OnPolicyConfig
      • nvalchemi.training.distillation.OnPolicySettings
      • nvalchemi.training.distillation.InitialStructures
      • nvalchemi.training.distillation.TeacherLabelHook
      • nvalchemi.training.distillation.nonfinite_divergence
      • nvalchemi.training.distillation.ReplayBuffer
      • nvalchemi.training.distillation.AdmissionPolicy
      • nvalchemi.training.distillation.EvictionPolicy
      • nvalchemi.training.distillation.FIFO
      • nvalchemi.training.distillation.ReplayEviction
      • nvalchemi.training.distillation.build_mixed_loader
      • nvalchemi.training.distillation.AtomicEnergyMatchingLoss
      • nvalchemi.training.distillation.EmbeddingMatchingLoss
      • nvalchemi.training.distillation.EmbeddingProjector
      • nvalchemi.training.distillation.HessianMatchingLoss
      • nvalchemi.training.distillation.BoltzmannMatchingLoss
      • nvalchemi.training.distillation.evaluation.evaluate_accuracy
      • nvalchemi.training.distillation.evaluation.AccuracyMetrics
      • nvalchemi.training.distillation.evaluation.AccuracyQuantity
      • nvalchemi.training.distillation.evaluation.AccuracyQuantitySpec
      • nvalchemi.training.distillation.evaluation.non_conservative_residual
      • nvalchemi.training.distillation.evaluation.NonConservativeResidual
      • nvalchemi.training.distillation.evaluation.extensivity_error
      • nvalchemi.training.distillation.evaluation.ExtensivityMetrics
      • nvalchemi.training.distillation.evaluation.radial_distribution
      • nvalchemi.training.distillation.evaluation.RadialDistribution
      • nvalchemi.training.distillation.evaluation.compare_radial_distributions
      • nvalchemi.training.distillation.evaluation.RDFComparison
      • nvalchemi.training.distillation.evaluation.build_acceptance_report
      • nvalchemi.training.distillation.evaluation.AcceptanceReport
      • nvalchemi.training.distillation.evaluation.AcceptanceThresholds
      • nvalchemi.training.distillation.evaluation.AcceptanceCheck
      • nvalchemi.training.distillation.evaluation.StudentEvaluation
      • nvalchemi.training.distillation.evaluation.StudentVerdict
      • nvalchemi.training.distillation.evaluation.MeasurementRecord
      • nvalchemi.training.distillation.evaluation.measured_bars
      • nvalchemi.training.distillation.evaluation.MetricFamily
      • nvalchemi.training.distillation.evaluation.AcceptanceBar
    • Training update hooks
      • nvalchemi.training.hooks.DDPHook
      • nvalchemi.training.hooks.MixedPrecisionHook
      • nvalchemi.training.hooks.TrainingUpdateHook
      • nvalchemi.training.hooks.TrainingUpdateOrchestrator
      • nvalchemi.training.hooks.EMAHook
      • nvalchemi.training.hooks.CheckpointHook
    • Losses — Training Terms
      • nvalchemi.training.BaseLossFunction
      • nvalchemi.training.ReductionContext
      • nvalchemi.training.ComposedLossFunction
      • nvalchemi.training.ComposedLossOutput
      • nvalchemi.training.LossWeightSchedule
      • nvalchemi.training.EnergyMSELoss
      • nvalchemi.training.EnergyMAELoss
      • nvalchemi.training.EnergyHuberLoss
      • nvalchemi.training.ForceMSELoss
      • nvalchemi.training.ForceHuberLoss
      • nvalchemi.training.ForceL2NormLoss
      • nvalchemi.training.StressMSELoss
      • nvalchemi.training.StressHuberLoss
      • nvalchemi.training.ConstantWeight
      • nvalchemi.training.LinearWeight
      • nvalchemi.training.CosineWeight
      • nvalchemi.training.PiecewiseWeight
      • nvalchemi.training.losses.reductions.per_graph_sum
      • nvalchemi.training.losses.reductions.per_graph_mean
      • nvalchemi.training.losses.reductions.graph_balanced_mean
      • nvalchemi.training.losses.reductions.masked_mean
      • nvalchemi.training.losses.reductions.frobenius_mse
    • Validation
      • nvalchemi.training.ValidationConfig
      • nvalchemi.training.ValidationLoop
      • nvalchemi.training.BatchValidationCallback
      • nvalchemi.training.ensure_reiterable_validation_data
  • Enhanced sampling API
    • nvalchemi.enhanced_sampling.EnhancedSampling
    • nvalchemi.enhanced_sampling.ThermodynamicState
    • nvalchemi.enhanced_sampling.ReplicaExchange
    • nvalchemi.enhanced_sampling.ConservativeBias
    • nvalchemi.enhanced_sampling.AdaptivePotentialMixin
    • nvalchemi.enhanced_sampling.BiasHook
    • nvalchemi.enhanced_sampling.EpochCommitHook
    • nvalchemi.enhanced_sampling.WalkerIdentityHook
    • nvalchemi.enhanced_sampling.HarmonicUmbrellaBias
    • nvalchemi.enhanced_sampling.UpperWall
    • nvalchemi.enhanced_sampling.LowerWall
    • nvalchemi.enhanced_sampling.FlatBottomRestraint
    • nvalchemi.enhanced_sampling.WellTemperedMetaDynamicsBias
    • nvalchemi.enhanced_sampling.RMSDMetaDynamicsBias
    • nvalchemi.enhanced_sampling.AdaptiveBiasingForce
    • nvalchemi.enhanced_sampling.pair_distance
    • nvalchemi.enhanced_sampling.pair_displacement
    • nvalchemi.enhanced_sampling.periodic_difference
  • Distributed (spatial domain decomposition)
    • nvalchemi.distributed.DomainParallel
    • nvalchemi.distributed.DomainConfig
    • nvalchemi.distributed.HookScope
    • nvalchemi.distributed.DistributedModel
    • nvalchemi.distributed.DistributedPipelineModel
    • nvalchemi.distributed.ShardedBatch
    • nvalchemi.distributed.SpatialPartitioner
    • nvalchemi.distributed.config.StrategyKind
    • nvalchemi.distributed.MLIPSpec
    • nvalchemi.distributed.DistributionSpec
    • nvalchemi.distributed.CompilePolicy
    • nvalchemi.distributed.ForceStrategy
    • nvalchemi.distributed.spec.SPEC_MPNN_HALO
    • nvalchemi.distributed.spec.SPEC_LJ_HALO
    • nvalchemi.distributed.spec.SPEC_UMA_HALO
    • nvalchemi.distributed.spec.SPEC_EWALD_HALO
    • nvalchemi.distributed.spec.SPEC_PME_HALO
    • nvalchemi.distributed.spec.SPEC_DFTD3_HALO
    • nvalchemi.distributed.spec.SPEC_MPNN_GP
    • nvalchemi.distributed.OpAdapter
    • nvalchemi.distributed.MethodAdapter
    • nvalchemi.distributed.FunctionAdapter
    • nvalchemi.distributed.PythonAdapter
    • nvalchemi.distributed.JitAdapter
    • nvalchemi.distributed.AdapterRegistry
    • nvalchemi.distributed.AdapterStatus
    • nvalchemi.distributed.OutputSpec
    • nvalchemi.distributed.OutputKind
    • nvalchemi.distributed.Reduce
    • nvalchemi.distributed.trace_and_validate
    • nvalchemi.distributed.distributed_method
    • nvalchemi.distributed.refresh_neighbors
    • nvalchemi.distributed.neighbor_refresh_adapters
    • nvalchemi.distributed.scatter_to_owners
    • nvalchemi.distributed.system_sum
    • nvalchemi.distributed.to_local
    • nvalchemi.distributed.localize
    • nvalchemi.distributed.current_dd_context
    • nvalchemi.distributed.autograd_target
    • nvalchemi.distributed.Scope
    • nvalchemi.distributed.GraphPadder
    • nvalchemi.distributed.COOPadder
    • nvalchemi.distributed.DensePadder
    • nvalchemi.distributed.DenseBatchPadder
    • nvalchemi.distributed.resolve_cap
    • nvalchemi.distributed.ParticleHaloConfig
    • nvalchemi.distributed.reshard_by_destination
  • Distributed runtime utilities
    • nvalchemi.distributed.DistributedManager
    • nvalchemi.distributed.PhysicsNeMoUninitializedDistributedManagerWarning
    • nvalchemi.distributed.ProcessGroupContext
    • nvalchemi.distributed.CollectivePhase
    • nvalchemi.distributed.collective_error_sync
    • nvalchemi.distributed.resolve_world_size
    • nvalchemi.distributed.resolve_global_rank
    • nvalchemi.distributed.collective_device
  • Crystal structure prediction API
    • nvalchemi.csp.MolecularPackingInput
    • nvalchemi.csp.chem.RDKitConformerConfig
    • nvalchemi.csp.chem.generate_conformers_from_smiles
    • nvalchemi.csp.chem.build_contact_distance_matrix
    • nvalchemi.csp.chem.build_molecular_packing_input
    • nvalchemi.csp.estimate_formula_unit_volume
    • nvalchemi.csp.get_default_atomic_volumes
    • nvalchemi.csp.CrystalSystem
    • nvalchemi.csp.SpaceGroupPolicy
    • nvalchemi.csp.get_space_group_candidates
    • nvalchemi.csp.sample_space_groups
    • nvalchemi.csp.csd_space_group_probabilities
    • nvalchemi.csp.get_space_group_operations
    • nvalchemi.csp.get_space_group_operation_count
    • nvalchemi.csp.get_crystal_system
    • nvalchemi.csp.is_sohncke_space_group
    • nvalchemi.csp.CSPGenerator
    • nvalchemi.csp.packer.CrystalPacker
    • nvalchemi.csp.packer.CandidateBudgetPacker
    • nvalchemi.csp.packer.PackingContext
    • nvalchemi.csp.packer.PackingReport
    • nvalchemi.csp.packer.PackingResult
    • nvalchemi.csp.packer.PackingStopReason
    • nvalchemi.csp.packer.OverlapReliefConfig
    • nvalchemi.csp.packer.OverlapReliefPacker
    • nvalchemi.csp.packer.OverlapReliefProgress
    • nvalchemi.csp.RigidMoleculeASUBatch
    • nvalchemi.csp.RigidMoleculeASUZarrWriter
    • nvalchemi.csp.RigidMoleculeASUZarrReader
    • nvalchemi.csp.comparison.RadialComparisonIndex
    • nvalchemi.csp.comparison.DeduplicationResult
    • nvalchemi.csp.comparison.deduplicate_batch
    • nvalchemi.csp.comparison.deduplicate_stream
    • nvalchemi.csp.comparison.iter_matches_stream
    • nvalchemi.csp.hooks.DeduplicationEngine
    • nvalchemi.csp.hooks.DeduplicateHook
    • nvalchemi.csp.chem.TopologicalAtomTypeMap
    • nvalchemi.csp.chem.topological_atom_types_from_connectivity
    • nvalchemi.csp.chem.topological_atom_types_from_mol
  • Typing module (type aliases, enums, protocols)
  • API Reference
  • Training strategy API
  • nvalchemi.tr...

nvalchemi.training.configure_parallelism#

nvalchemi.training.configure_parallelism(models, *, strategy='none')[source]#

Configure model parallelism, preserving input shape.

Parameters:
  • models (torch.nn.Module | dict[str, torch.nn.Module] | torch.nn.ModuleDict)

  • strategy (str, optional)

Return type:

torch.nn.Module | dict[str, torch.nn.Module] | torch.nn.ModuleDict

Raises:

NotImplementedError – For any strategy other than "none".

previous

nvalchemi.training.configure_dataloader

next

nvalchemi.training.move_to_devices

On this page
  • configure_parallelism()
Show Source

© Copyright 2026, NVIDIA.

Created using Sphinx 9.1.0.

Built with the PyData Sphinx Theme 0.15.2.