Skip to main content

Nessai: Nested Sampling with Artificial Intelligence

Project description

DOI PyPI Conda Version Documentation Status license tests int-tests codecov gitter

nessai: Nested Sampling with Artificial Intelligence

nessai (/ˈnɛsi/): Nested Sampling with Artificial Intelligence

nessai is a nested sampling algorithm for Bayesian Inference that incorporates normalising flows. It is designed for applications where the Bayesian likelihood is computationally expensive.

Installation

nessai can be installed using pip:

pip install nessai

or via conda

conda install -c conda-forge -c pytorch nessai

PyTorch

By default the version of PyTorch will not necessarily match the drivers on your system, to install a different version with the correct CUDA support see the PyTorch homepage for instructions: https://pytorch.org/.

Using bilby

As of bilby version 2.3.0, the recommended way to use nessai is via the nessai-bilby sampler plugin. This can be installed via either conda or pip and provides the most up-to-date interface for nessai. This includes support for the importance nested sampler (inessai).

It can be installed using either

pip install nessai-bilby

or

conda install -c conda-forge nessai-bilby

See the examples included with nessai for how to run nessai via bilby.

Documentation

Documentation is available at: nessai.readthedocs.io

Help

For questions and other support, please either use our gitter room or open an issue.

Contributing

Please see the guidelines here.

Acknowledgements

The core nested sampling code, model design and code for computing the posterior in nessai was based on cpnest with permission from the authors.

The normalising flows implemented in nessai are all either directly imported from nflows or heavily based on it.

Other code snippets that draw on existing code reference the source in their corresponding doc-strings.

The authors also thank Christian Chapman-Bird, Laurence Datrier, Fergus Hayes, Jethro Linley and Simon Tait for their feedback and help finding bugs in nessai.

Citing

If you find nessai useful in your work please cite the DOI for this code and our papers:

@software{nessai,
  author       = {Michael J. Williams},
  title        = {nessai: Nested Sampling with Artificial Intelligence},
  month        = feb,
  year         = 2021,
  publisher    = {Zenodo},
  version      = {latest},
  doi          = {10.5281/zenodo.4550693},
  url          = {https://doi.org/10.5281/zenodo.4550693}
}

@article{Williams:2021qyt,
    author = "Williams, Michael J. and Veitch, John and Messenger, Chris",
    title = "{Nested sampling with normalizing flows for gravitational-wave inference}",
    eprint = "2102.11056",
    archivePrefix = "arXiv",
    primaryClass = "gr-qc",
    doi = "10.1103/PhysRevD.103.103006",
    journal = "Phys. Rev. D",
    volume = "103",
    number = "10",
    pages = "103006",
    year = "2021"
}

@article{Williams:2023ppp,
    author = "Williams, Michael J. and Veitch, John and Messenger, Chris",
    title = "{Importance nested sampling with normalising flows}",
    eprint = "2302.08526",
    archivePrefix = "arXiv",
    primaryClass = "astro-ph.IM",
    reportNumber = "LIGO-P2200283",
    month = "2",
    year = "2023"
}

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

nessai-0.14.0.post0.tar.gz (324.9 kB view details)

Uploaded Source

Built Distribution

nessai-0.14.0.post0-py3-none-any.whl (181.2 kB view details)

Uploaded Python 3

File details

Details for the file nessai-0.14.0.post0.tar.gz.

File metadata

  • Download URL: nessai-0.14.0.post0.tar.gz
  • Upload date:
  • Size: 324.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for nessai-0.14.0.post0.tar.gz
Algorithm Hash digest
SHA256 6027fc820f39c0d59e66b26d4a1b4a29557389422bdc69333819321af1e8b38b
MD5 01642fe0caf16ec8dae5fa5ffc1c8252
BLAKE2b-256 cf6217a89c5a3b52434d92c62a6da8616a196b13dd7044a08fb5688e82e72176

See more details on using hashes here.

File details

Details for the file nessai-0.14.0.post0-py3-none-any.whl.

File metadata

  • Download URL: nessai-0.14.0.post0-py3-none-any.whl
  • Upload date:
  • Size: 181.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for nessai-0.14.0.post0-py3-none-any.whl
Algorithm Hash digest
SHA256 d3c8a4b1e861f63bd751e807bb03d290b13f01f0cbfd9c0e3ea5ec10de95cd23
MD5 56435e9b67fdf284d6c3e4d5f6ece99b
BLAKE2b-256 bb83edec28d25c3cc0dc910421009597758a35a1b7e5f936730e116bae299a07

See more details on using hashes here.

Supported by

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