PyPIELM Documentation

Getting Started

• Installation
• Quickstart

Tutorials

• Tutorial: Solving 1D Poisson with CorePIELM
  • Step 1 — Set up the dataset
  • Step 2 — Define the PDE operator
  • Step 3 — Train the model
  • Step 4 — Evaluate
  • Step 5 — Visualise
  • Full runnable script
• Tutorial: 2D Heat Equation
  • Problem setup
  • Dataset
  • PDE operator
  • Training and evaluation
  • Full runnable script
• Tutorial: Inverse Problem — Identify PDE Coefficients
  • Problem
  • Strategy: Embedded Coefficient Identification
  • Reference
• Tutorial: Reproducible Experiments with YAML and the CLI
  • YAML Config Format
  • Run a Single Experiment
  • Batch Sweep
  • Export a Trained Model
  • List All Models

API Reference

• pypielm
• Core Abstractions (pypielm.core)
  • BasePIELM
  • Feature Maps
  • Solvers
• Model Library (pypielm.models)
  • VanillaPIELM
  • CorePIELM
  • BayesianPIELM
  • GFFPIELM
  • DPIELM
  • LocELM
  • DDELMCoarse
  • CurriculumPIELM
  • NullSpacePIELM
  • EigPIELM
  • LSEELM
  • StefanPIELM
  • NormalEquationELM
  • ParameterRetentionELM
  • PiecewiseELM
  • DELM
  • FPIELM
  • SGEPIELM
  • RINN
  • RaNNPIELM
  • XPIELM
  • PIELMRVDS
  • TSPIELM
  • KAPIELM
  • SoftPartitionKAPIELM
  • VanillaPINN
  • AdaptivePINN
  • FourierPINN
  • MuonPINN
  • ResidualAdaptivePINN
  • get_model()
  • register()
  • Registry
  • VanillaPIELM / CorePIELM
  • BayesianPIELM
  • GFF-PIELM (Fourier)
  • Domain Decomposition
  • CurriculumPIELM
  • Constrained Variants
  • PINN Baselines
• PDE Layer (pypielm.pde)
  • gradient()
  • laplacian()
  • divergence()
  • advection_term()
  • AnalyticLaplacian
  • BoxDomain
  • UniformSampler
  • LHSSampler
  • AdaptiveSampler
  • GridSampler
  • DirichletBC
  • NeumannBC
  • InitialCondition
  • PeriodicBC
  • Differential Operators
  • Collocation Samplers
  • Boundary & Initial Conditions
• Data Layer (pypielm.data)
  • PIELMDataset
  • Adapters
  • Transforms
• Metrics (pypielm.metrics)
  • rmse()
  • mae()
  • relative_l2()
  • max_error()
  • r2_score()
  • MetricsBundle
  • rmse()
  • mae()
  • relative_l2()
  • max_error()
  • r2_score()
  • MetricsBundle
• I/O & Export (pypielm.io)
  • save_model()
  • load_model()
  • to_onnx()
  • to_torchscript()
  • Checkpointing
  • Model Export
• Visualization (pypielm.visualization)
  • plot_solution_1d()
  • plot_solution_2d()
  • plot_training_history()
  • plot_pareto()
  • plot_leaderboard_heatmap()
  • save_figure()
  • plot_solution_1d()
  • plot_solution_2d()
  • plot_training_history()
  • plot_pareto()
  • plot_leaderboard_heatmap()
  • save_figure()
• Utilities (pypielm.utils)
  • seed_everything()
  • get_device()
  • Config Loader
  • Reproducibility

Development

• Contributing to PyPIELM
• Changelog

Indices and tables

• Index

• Module Index

• Search Page