API reference

This API reference contains a collection of all functions, modules, and objects available in mlip, along with detailed descriptions of their purpose and operation.

• Data processing
  • Graph Dataset Builder
  • Chemical System Readers
  • Chemical System
  • Dataset Info
  • Dataset Configs
  • Atomic Number Table
  • Graph Definition
  • Graph Dataset
  • Data parallelization and batch prefetching
  • Data split
  • Helper functions
• Models
  • MLIP Network: Base Class
  • MACE
  • NequIP
  • ViSNet
  • Force Field predictor
  • Force Field
  • Prediction
  • Model I/O
  • Loss
  • Model options: Enum classes
• Model training
  • Training Loop
  • Training Loop Config
  • Training state
  • Training step
  • Optimizer
  • Exponential Moving Average (EMA)
  • IO handling during training
  • Model evaluation
  • Fine-tuning utilities
• Simulations
  • Simulation Engine: Interface
  • Simulation Config
  • Simulation State
  • Simulation Enums
  • Create graph from ASE atoms
  • JAX-MD Simulation Engine
  • JAX-MD Simulation Config
  • ASE Simulation Engine
  • MLIP ASE Calculator
  • ASE Simulation Config
  • Temperature scheduling
  • Batched inference