Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
metatrain 0.1.dev1+ga984f4e3a documentation
Light Logo Dark Logo
  • Installation
  • Getting started
    • Quickstart
    • Basic Usage
    • Customize a Dataset Configuration
    • Advanced Base Configuration
    • Override Architecture’s Default Parameters
    • Restarting and Checkpoints
    • Finetuning example
  • Configuration and Units
    • Units
  • Available Architectures
    • GAP
    • LLPR
    • NanoPET (deprecated)
    • PET
    • SOAP-BPNN
  • Tutorials
    • Beginner Tutorials
      • How to prepare data for training
      • Fine-tuning
      • Training a model from scratch
      • Running molecular dynamics with ASE
    • Advanced Tutorials
      • Transfer Learning (experimental)
      • Computing LLPR uncertainties
      • Training a model with ZBL corrections
      • Fitting generic targets
  • Concepts and Design
    • Output naming
    • Loss functions
    • Auxiliary outputs
    • Multi-GPU training
  • Citing Metatrain
  • Developer documentation
    • Contributing
    • Life Cycle of an Architecture
    • Adding a new architecture
    • Dataset Information
    • Adding a new loss function
    • CLI API
      • Train
      • Eval
      • Export
      • Formatter
    • Utility API
      • Additive models
        • Removing additive contributions
        • Composition model
        • ZBL short-range potential
      • Data
        • Combining dataloaders
        • Dataset
        • Reading a dataset
        • Readers
        • Target data Writers
        • Converting Systems to ASE
      • Architectures
      • Augmentation
      • Device
      • Dtype
      • Errors
      • Evaluating a model
      • External Naming
      • IO
      • Jsonschema
      • Logging
      • Long-range
      • Loss
      • Metrics
      • Neighbor lists
      • Custom omegaconf functions
      • Output gradient
      • Averaging predictions per atom
      • Scaler
      • Summing over atoms
      • Data type and device transfers
      • Unit handling
    • Changelog
Back to top
View this page

Getting started¶

This sections describes how to install the package, and its most basic commands.

  • Quickstart
  • Basic Usage
  • Customize a Dataset Configuration
  • Advanced Base Configuration
  • Override Architecture’s Default Parameters
  • Restarting and Checkpoints
  • Finetuning example
Next
Quickstart
Previous
Installation
Copyright © 2025, metatrain developers
Made with Sphinx and @pradyunsg's Furo