Skip to main content

A High-Level PyTorch based Library for Hybrid Physics-Informed Machine Learning Models

Project description

Auto-differentiable embedding of Physics and Torch Machine Learning (AdePT-ML):

This is a convienience library built on top of PyTorch to enable easy integration and training of hybrid models involving physics and deep learning modules.

Features

  1. Allows integration of torch.nn.module with numpy functions and enable training with torch optimizers.
  2. Pre-defined Modules and configs for physics and MLP architectures.
  3. Integrated training function with tensorboard support.

Installation

Installing with pip

pip install adeptml 

Requirements (Automatically installed with pip):

  1. PyTorch (https://pytorch.org/)
  2. Joblib (https://joblib.readthedocs.io/en/latest/) (For loading and saving model parameters)
  3. Tensorboard

Usage:

The primary building block of this package is the Hybrid Model class. It neatly packages all the member models into one main Torch model and enables running forward inference as well as backpropagation. The class accepts as input an instance of the Hybrid Config class. This config is useful in defining all the constituent modules and their inputs.

As component modules, the Models module provides a straight forward MLP implementation as well as a Physics Module. This module is a torch Autograd wrapper which enables the integration of non-Torch numpy functions into a fully torch model and allows for training with torch optimizers.

API Documentation:

Visit our Read the docs page

Examples:

Refer to the tests file. Additional examples will be added soon.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adeptml-2.1.tar.gz (9.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

adeptml-2.1-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

Details for the file adeptml-2.1.tar.gz.

File metadata

  • Download URL: adeptml-2.1.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.7 Linux/6.6.87.2-microsoft-standard-WSL2

File hashes

Hashes for adeptml-2.1.tar.gz
Algorithm Hash digest
SHA256 5047280b8a3c3e75cd217f051d182ca4bff501477405315a910e63928036c0e8
MD5 2cabeed5da27f9047b05d0cd6053c011
BLAKE2b-256 58b324dee12562c4eefd01607d250aa7d77589dc55223edf30ae05d03fb882c4

See more details on using hashes here.

File details

Details for the file adeptml-2.1-py3-none-any.whl.

File metadata

  • Download URL: adeptml-2.1-py3-none-any.whl
  • Upload date:
  • Size: 11.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.7 Linux/6.6.87.2-microsoft-standard-WSL2

File hashes

Hashes for adeptml-2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5621797a52980db335f9b982329dc54ff1e24fd737d01adeb1de72ac03a9892e
MD5 9b22ec2c63e5b5aa68e8974f97fabe63
BLAKE2b-256 003f9f59368155a1d01a65db301769cd974ed82ecee0f17c9e56fcad2266d005

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page