Metadata-Version: 2.4
Name: polyswyft
Version: 0.4.3
Summary: Sequential simulation-based nested sampling combining PolyChord and swyft
Author-email: Kilian Scheutwinkel <khs40@cantab.ac.uk>
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
        TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
        1.  Definitions.
        
            "License" shall mean the terms and conditions for use, reproduction,
            and distribution as defined by Sections 1 through 9 of this document.
        
            "Licensor" shall mean the copyright owner or entity granting the License.
        
            "Legal Entity" shall mean the union of the acting entity and all
            other entities that control, are controlled by, or are under common
            control with that entity. For the purposes of this definition,
            "control" means (i) the power, direct or indirect, to cause the
            direction or management of such entity, whether by contract or
            otherwise, or (ii) ownership of fifty percent (50%) or more of the
            outstanding shares, or (iii) beneficial ownership of such entity.
        
            "You" (or "Your") shall mean an individual or Legal Entity
            exercising permissions granted by this License.
        
            "Source" shall mean the preferred form for making modifications,
            including but not limited to software source code, documentation
            source, and configuration files.
        
            "Object" shall mean any form resulting from mechanical
            transformation or translation of a Source form, including but
            not limited to compiled object code, generated documentation,
            and conversions to other media types.
        
            "Work" shall mean the work of authorship, whether in Source or
            Object form, made available under the License, as indicated by a
            copyright notice that is included in or attached to the work
            (which shall not include communications that are clearly marked or
            otherwise designated in writing by the copyright owner as "Not a Work").
        
            "Derivative Works" shall mean any work, whether in Source or Object
            form, that is based upon (or derived from) the Work and for which the
            editorial revisions, annotations, elaborations, or other modifications
            represent, as a whole, an original work of authorship. For the purposes
            of this License, Derivative Works shall not include works that remain
            separable from, or merely link (or bind by name) to the interfaces of,
            the Work and derivative works thereof.
        
            "Contribution" shall mean any work of authorship, including
            the original version of the Work and any modifications or additions
            to that Work or Derivative Works thereof, that is intentionally
            submitted to Licensor for inclusion in the Work by the copyright owner
            or by an individual or Legal Entity authorized to submit on behalf of
            the copyright owner. For the purposes of this definition, "submitted"
            means any form of electronic, verbal, or written communication sent
            to the Licensor or its representatives, including but not limited to
            communication on electronic mailing lists, source code control
            systems, and issue tracking systems that are managed by, or on behalf
            of, the Licensor for the purpose of discussing and improving the Work,
            but excluding communication that is conspicuously marked or otherwise
            designated in writing by the copyright owner as "Not a Work".
        
        2.  Grant of Copyright License. Subject to the terms and conditions of
            this License, each Contributor hereby grants to You a perpetual,
            worldwide, non-exclusive, no-charge, royalty-free, irrevocable
            copyright license to use, reproduce, modify, merge, publish,
            distribute, sublicense, and/or sell copies of the Work, and to
            permit persons to whom the Work is furnished to do so, subject to
            the following conditions:
        
            The above copyright notice and this permission notice shall be
            included in all copies or substantial portions of the Work.
        
        3.  Grant of Patent License. Subject to the terms and conditions of
            this License, each Contributor hereby grants to You a perpetual,
            worldwide, non-exclusive, no-charge, royalty-free, irrevocable
            (except as stated in this section) patent license to make, have made,
            use, offer to sell, sell, import, and otherwise transfer the Work,
            where such license applies only to those patent claims licensable
            by such Contributor that are necessarily infringed by their
            Contribution(s) alone or by combination of their Contribution(s)
            with the Work to which such Contribution(s) was submitted. If You
            institute patent litigation against any entity (including a
            cross-claim or counterclaim in a lawsuit) alleging that the Work
            or a Contribution incorporated within the Work constitutes direct
            or contributory patent infringement, then any patent licenses
            granted to You under this License for that Work shall terminate
            as of the date such litigation is filed.
        
        4.  Redistribution. You may reproduce and distribute copies of the
            Work or Derivative Works thereof in any medium, with or without
            modifications, and in Source or Object form, provided that You
            meet the following conditions:
        
            (a) You must give any other recipients of the Work or
            Derivative Works a copy of this License; and
        
            (b) You must cause any modified files to carry prominent notices
            stating that You changed the files; and
        
            (c) You must retain, in the Source form of any Derivative Works
            that You distribute, all copyright, patent, trademark, and
            attribution notices from the Source form of the Work,
            excluding those notices that do not pertain to any part of
            the Derivative Works; and
        
            (d) If the Work includes a "NOTICE" text file as part of its
            distribution, then any Derivative Works that You distribute must
            include a readable copy of the attribution notices contained
            within such NOTICE file, excluding those notices that do not
            pertain to any part of the Derivative Works, in at least one
            of the following places: within a NOTICE text file distributed
            as part of the Derivative Works; within the Source form or
            documentation, if provided along with the Derivative Works; or,
            within a display generated by the Derivative Works, if and
            wherever such third-party notices normally appear. The contents
            of the NOTICE file are for informational purposes only and
            do not modify the License. You may add Your own attribution
            notices within Derivative Works that You distribute, alongside
            or as an addendum to the NOTICE text from the Work, provided
            that such additional attribution notices cannot be construed
            as modifying the License.
        
            You may add Your own copyright notice to Your modifications and
            may provide additional or different license terms and conditions
            for use, reproduction, or distribution of Your modifications, or
            for any such Derivative Works as a whole, provided Your use,
            reproduction, and distribution of the Work otherwise complies with
            the conditions stated in this License.
        
        5.  Submission of Contributions. Unless You explicitly state otherwise,
            any Contribution intentionally submitted for inclusion in the Work
            by You to the Licensor shall be under the terms and conditions of
            this License, without any additional terms or conditions.
            Notwithstanding the above, nothing herein shall supersede or modify
            the terms of any separate license agreement you may have executed
            with Licensor regarding such Contributions.
        
        6.  Trademarks. This License does not grant permission to use the trade
            names, trademarks, service marks, or product names of the Licensor,
            except as required for reasonable and customary use in describing the
            origin of the Work and reproducing the content of the NOTICE file.
        
        7.  Disclaimer of Warranty. Unless required by applicable law or
            agreed to in writing, Licensor provides the Work (and each
            Contributor provides its Contributions) on an "AS IS" BASIS,
            WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
            implied, including, without limitation, any warranties or conditions
            of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
            PARTICULAR PURPOSE. You are solely responsible for determining the
            appropriateness of using or redistributing the Work and assume any
            risks associated with Your exercise of permissions under this License.
        
        8.  Limitation of Liability. In no event and under no legal theory,
            whether in tort (including negligence), contract, or otherwise,
            unless required by applicable law (such as deliberate and grossly
            negligent acts) or agreed to in writing, shall any Contributor be
            liable to You for damages, including any direct, indirect, special,
            incidental, or consequential damages of any character arising as a
            result of this License or out of the use or inability to use the
            Work (including but not limited to damages for loss of goodwill,
            work stoppage, computer failure or malfunction, or any and all
            other commercial damages or losses), even if such Contributor
            has been advised of the possibility of such damages.
        
        9.  Accepting Warranty or Support. You may choose to offer, and to
            charge a fee for, acceptance of support, warranty, indemnity,
            or other liability obligations and/or rights consistent with this
            License. However, in accepting such obligations, You may act only
            on Your own behalf and on Your sole responsibility, not on behalf
            of any other Contributor, and only if You agree to indemnify,
            defend, and hold each Contributor harmless for any liability
            incurred by, or claims asserted against, such Contributor by reason
            of your accepting any such warranty or support.
        
        END OF TERMS AND CONDITIONS
        
        APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
        Copyright 2024 Kilian Scheutwinkel
        
        Licensed under the Apache License, Version 2.0 (the "License");
        you may not use this file except in compliance with the License.
        You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
        Unless required by applicable law or agreed to in writing, software
        distributed under the License is distributed on an "AS IS" BASIS,
        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
        See the License for the specific language governing permissions and
        limitations under the License.
        
        ===============================================================================
        THIRD-PARTY DEPENDENCY NOTICE
        ===============================================================================
        
        PolySwyft depends on PolyChord (https://github.com/PolyChord/PolyChordLite),
        which is licensed separately under the PolyChord License Agreement. PolyChord
        is copyrighted by Will Handley, Mike Hobson & Anthony Lasenby and is licensed
        for non-commercial, academic, and research use only. Commercial use of
        PolyChord requires a separate license from the PolyChord authors
        (wh260@mrao.cam.ac.uk).
        
        Users of PolySwyft must independently comply with PolyChord's license terms.
        The Apache 2.0 license above applies solely to the PolySwyft source code and
        does not extend to or override the license terms of PolyChord or any other
        third-party dependency.
        
Project-URL: Homepage, https://github.com/kilian1103/PolySwyft
Project-URL: Documentation, https://arxiv.org/abs/2512.08316
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.24
Requires-Dist: scipy<1.14,>=1.11
Requires-Dist: torch<2.3,>=2.0; platform_system == "Darwin" and platform_machine == "x86_64"
Requires-Dist: torch>=2.0; platform_system != "Darwin" or platform_machine != "x86_64"
Requires-Dist: pytorch-lightning<2,>=1.9
Requires-Dist: anesthetic>=2.0
Requires-Dist: swyft==0.4.4
Provides-Extra: mpi
Requires-Dist: mpi4py>=3.0; extra == "mpi"
Provides-Extra: wandb
Requires-Dist: wandb; extra == "wandb"
Provides-Extra: examples
Requires-Dist: lsbi>=0.9; extra == "examples"
Provides-Extra: cmb
Requires-Dist: cosmopower; extra == "cmb"
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"
Requires-Dist: ruff>=0.4; extra == "dev"
Provides-Extra: notebook
Requires-Dist: jupyter; extra == "notebook"
Requires-Dist: notebook; extra == "notebook"
Provides-Extra: all
Requires-Dist: mpi4py>=3.0; extra == "all"
Requires-Dist: wandb; extra == "all"
Requires-Dist: lsbi>=0.9; extra == "all"
Requires-Dist: cosmopower; extra == "all"
Requires-Dist: pytest>=7.0; extra == "all"
Requires-Dist: pytest-cov>=4.0; extra == "all"
Requires-Dist: ruff>=0.4; extra == "all"
Requires-Dist: jupyter; extra == "all"
Requires-Dist: notebook; extra == "all"
Dynamic: license-file

# Nested Sampling Neural Ratio Estimator (NSNRE)

<div align="center">

[![CI](https://github.com/kilian1103/PolySwyft/actions/workflows/ci.yml/badge.svg)](https://github.com/kilian1103/PolySwyft/actions/workflows/ci.yml)
[![Lint](https://github.com/kilian1103/PolySwyft/actions/workflows/lint.yml/badge.svg)](https://github.com/kilian1103/PolySwyft/actions/workflows/lint.yml)
[![PyPI](https://img.shields.io/pypi/v/polyswyft.svg)](https://pypi.org/project/polyswyft/)
[![Python](https://img.shields.io/badge/Python-3.9+-blue.svg)](https://python.org)
[![PyTorch](https://img.shields.io/badge/PyTorch-2.0+-red.svg)](https://pytorch.org)
[![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](https://opensource.org/licenses/Apache-2.0)
[![arXiv](https://img.shields.io/badge/arXiv-2512.08316-b31b1b.svg)](https://arxiv.org/abs/2512.08316)

</div>

## PolySwyft

**PolySwyft** is an implementation of a Nested Sampling Neural-Ratio-Estimator (NSNRE) that combines
[PolyChord](https://github.com/PolyChord/PolyChordLite) and [swyft](https://github.com/undark-lab/swyft) in a
PyTorch-based framework.

### Key Features

- **Sequential Neural Ratio Estimation**: Advanced nested sampling with neural networks, MPI compatibility
- **Multi-round Training**: Progressive improvement through multiple training rounds
- **Comprehensive Diagnostics**: Built-in KL-divergence and convergence monitoring
- **Modular Design**: Subclass `PolySwyftNetwork` and `swyft.Simulator` for your own problems
- **Experiment Tracking**: Integrated Weights & Biases support

## Installation

### Install the core package

```bash
# pip
pip install polyswyft

# uv
uv add polyswyft
```

This installs the `polyswyft` package with its core dependencies. You can then import:

```python
from polyswyft import PolySwyft, PolySwyftNetwork, PolySwyftSettings
```

### Optional dependencies

```bash
# pip
pip install "polyswyft[mpi]"       # MPI support (mpi4py)
pip install "polyswyft[examples]"  # lsbi for MVG/GMM examples
pip install "polyswyft[cmb]"       # cmblike for CMB example
pip install "polyswyft[wandb]"     # Weights & Biases tracking
pip install "polyswyft[dev]"       # pytest for running tests
pip install "polyswyft[all]"       # everything

# uv
uv add "polyswyft[mpi]"
uv add "polyswyft[examples]"
uv add "polyswyft[all]"            # etc.
```

### PolyChordLite

PolyChord must be installed separately:

```bash
git clone https://github.com/PolyChord/PolyChordLite.git
cd PolyChordLite
make
pip install .
cd .. && rm -rf PolyChordLite
```

### CMB Likelihood Library (for CMB example only)

```bash
git clone https://github.com/htjb/cmb-likelihood.git
cd cmb-likelihood
pip install .
cd .. && rm -rf cmb-likelihood
```

## Quick Start

The repository has two parts:

1. **`polyswyft/`** — the pip-installable core algorithm
2. **`examples/`** — paper examples demonstrating how to use the core algorithm

To use PolySwyft for your own problem, you need to:

1. **Subclass `swyft.Simulator`** — define your forward model (prior, likelihood)
2. **Subclass `PolySwyftNetwork`** — define your network architecture, prior transform, and log-ratio function
3. **Wire them together** with `PolySwyftSettings` and `PolySwyft`

See `examples/mvg/` for the simplest example, or `main.ipynb` for a step-by-step notebook walkthrough.

### Running the examples

Each example domain (MVG, GMM, CMB) has three scripts:

```bash
# Multivariate Gaussian example
cd examples/mvg
mpirun -n 4 python run_polyswyft.py   # PolySwyft (NSNRE)
mpirun -n 4 python run_swyft.py       # swyft baseline (TNRE)
mpirun -n 4 python run_polychord.py   # PolyChord baseline (exact likelihood)
```

> **Important**: Ensure your parameter dimensions follow the shape `(n, dim(theta))` and `(n, dim(D))` respectively,
> where `n` is the number of samples in your Simulator class. This is particularly important when `dim(theta)` and/or
> `dim(D) = 1`.

## Project Structure

```
polyswyft/                  # core pip-installable package
    __init__.py             # public API
    core.py                 # PolySwyft class (NSNRE cycle)
    network.py              # PolySwyftNetwork ABC
    settings.py             # PolySwyftSettings
    dataloader.py           # PolySwyftDataModule + PolySwyftSequential
    utils.py                # KL divergence, deadpoints, plotting reload

examples/                   # paper examples (not pip-installed)
    mvg/                    # Multivariate Gaussian
        simulator.py        # swyft.Simulator subclass (lsbi LinearModel)
        network.py          # PolySwyftNetwork subclass
        run_polyswyft.py    # main PolySwyft run script
        run_swyft.py        # swyft TNRE baseline
        run_polychord.py    # PolyChord baseline
    gmm/                    # Gaussian Mixture Model
        ...                 # same structure
    cmb/                    # CMB Cosmology
        ...                 # same structure
    plotting.py             # shared plotting utilities

tests/                      # test suite
main.ipynb                  # notebook walkthrough
```

### Core Components

**`PolySwyftNetwork`** (`polyswyft/network.py`) — Abstract base class extending `swyft.SwyftModule` with PolyChord compatibility. Implement these methods:

- `forward(A, B)` — swyft forward pass computing log-ratios
- `prior(cube)` — unit cube to prior transform for PolyChord
- `logRatio(theta)` — NRE log-ratio for PolyChord (replaces the standard log-likelihood)
- `get_new_network()` — factory for fresh network instances

**`PolySwyft`** (`polyswyft/core.py`) — Orchestrates the sequential NSNRE cycle: train NRE, run PolyChord with the trained ratio, use deadpoints for next round.

**`PolySwyftDataModule`** (`polyswyft/dataloader.py`) — Multi-round data management. Handles progressive training across multiple rounds with efficient batch selection.

**`PolySwyftSettings`** (`polyswyft/settings.py`) — Configuration for all algorithm parameters.

### Output Structure

When PolySwyft runs, it creates a structured output directory:

```
project_root/
    round_0/
        NRE_network.pt    # neural network weights
        optimizer_file.pt  # optimizer state
        x.npy              # data samples
        z.npy              # parameter samples with (z,x) ~ p(theta,D)
        samples.*          # nested sampling output (anesthetic compatible)
        wandb/             # Weights & Biases logs
    round_1/
        ...
    settings.pkl           # polyswyft settings pickle file
```

Each `round_i/` folder contains the trained network, optimizer state, deadpoints from nested sampling, and joint samples used for training. Round 0 contains full prior samples; subsequent rounds contain samples created via deadpoints from previous rounds. The dataloader randomly selects batches from all rounds up to and including the current round.

## Contributors

### Main Contributor

- **Kilian Scheutwinkel** - _Lead Developer & Researcher_

### Project Supervisors

- **Will Handley** - _Project Supervisor_
- **Christoph Weniger** - _Project Supervisor_
- **Eloy de Lera Acedo** - _Project Supervisor_

## License

This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.

> **Third-party notice:** PolySwyft depends on [PolyChord](https://github.com/PolyChord/PolyChordLite), which is licensed separately under the PolyChord License Agreement for non-commercial, academic, and research use only. Commercial use of PolyChord requires a separate license from its authors. See the `THIRD-PARTY DEPENDENCY NOTICE` section at the bottom of [LICENSE](LICENSE) for the full notice.

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to
discuss what you would like to change.

## Citation

If you use PolySwyft in your research, please cite:

```bibtex
@article{scheutwinkel_polyswyft_2025,
    title = {{PolySwyft}: sequential simulation-based nested sampling},
    shorttitle = {{PolySwyft}},
    url = {http://arxiv.org/abs/2512.08316},
    doi = {10.48550/arXiv.2512.08316},
    abstract = {We present PolySwyft, a novel, non-amortised simulation-based inference framework that unites the strengths of nested sampling (NS) and neural ratio estimation (NRE) to tackle challenging posterior distributions when the likelihood is intractable but a forward simulator is available. By nesting rounds of NRE within the exploration of NS, and employing a principled KL-divergence criterion to adaptively terminate sampling, PolySwyft achieves faster convergence on complex, multimodal targets while rigorously preserving Bayesian validity. On a suite of toy problems with analytically known posteriors of a dim(theta,D)=(5,100) multivariate Gaussian and multivariate correlated Gaussian mixture model, we demonstrate that PolySwyft recovers all modes and credible regions with fewer simulator calls than swyft's TNRE. As a real-world application, we infer cosmological parameters dim(theta,D)=(6,111) from CMB power spectra using CosmoPower. PolySwyft is released as open-source software, offering a flexible toolkit for efficient, accurate inference across the astrophysical sciences and beyond.},
    urldate = {2025-12-10},
    publisher = {arXiv},
    author = {Scheutwinkel, Kilian H. and Handley, Will and Weniger, Christoph and Acedo, Eloy de Lera},
    month = dec,
    year = {2025},
    note = {arXiv:2512.08316 [astro-ph]},
    keywords = {Astrophysics - Cosmology and Nongalactic Astrophysics, Astrophysics - Instrumentation and Methods for Astrophysics},
}
```

## Support

For questions, issues, or contributions, please:

- Open an issue on GitHub
- Contact the main contributor: [Kilian Scheutwinkel](mailto:khs40@cantab.ac.uk)
