Metadata-Version: 2.4
Name: multistage
Version: 0.2b0
Summary: Multistage neural networks with JAX
Home-page: https://github.com/unalmis/multistage
Author: Kaya Unalmis
Author-email: kunalmis@stanford.edu
License: MIT
Project-URL: Issues Tracker, https://github.com/unalmis/multistage/issues
Project-URL: Contributing, https://github.com/unalmis/multistage/blob/master/CONTRIBUTING.rst
Project-URL: Source Code, https://github.com/unalmis/multistage/
Project-URL: Documentation, https://unalmis.github.io/multistage/
Keywords: neural network optimization pde inverse
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: equinox!=0.13.3,>=0.13.1
Requires-Dist: interpax_fft>=0.0.8
Requires-Dist: jax!=0.5.1,!=0.5.2,!=0.6.0,!=0.7.1,<=0.8.2,>=0.5.0
Requires-Dist: lineax
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: optax
Requires-Dist: optimistix
Requires-Dist: orbax-checkpoint
Requires-Dist: orthax
Requires-Dist: paramax
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

##########
multistage
##########
|License| |Issues| |Pypi|

|Docs| |UnitTests|

``multistage`` is a library for multistage neural networks.

Installation
============

``multistage`` is installable with ``pip``:

.. code-block:: sh

    pip install multistage

or from GitHub:

.. code-block:: sh

    git clone https://github.com/unalmis/multistage.git
    cd multistage
    pip install --editable .

You may optionally install the developer requirements if you want to run tests.

.. code-block:: sh

    pip install -r requirements-dev.txt


For full details of various options see the `API documentation <https://unalmis.github.io/multistage/>`__.


.. |License| image:: https://img.shields.io/github/license/unalmis/multistage?color=blue&logo=open-source-initiative&logoColor=white
    :target: https://github.com/unalmis/multistage/blob/main/LICENSE
    :alt: License

.. |Docs| image:: https://github.com/unalmis/multistage/actions/workflows/docs.yml/badge.svg
    :target: https://unalmis.github.io/multistage/
    :alt: Documentation

.. |UnitTests| image:: https://github.com/unalmis/multistage/actions/workflows/unittest.yml/badge.svg
    :target: https://github.com/unalmis/multistage/actions/workflows/unittest.yml
    :alt: UnitTests

.. |Issues| image:: https://img.shields.io/github/issues/unalmis/multistage
    :target: https://github.com/unalmis/multistage/issues
    :alt: GitHub issues

.. |Pypi| image:: https://img.shields.io/pypi/v/multistage
    :target: https://pypi.org/project/multistage/
    :alt: Pypi
