Skip to main content

nessai in pure PyTorch

Project description

nessai-torch

DOI PyPI Tests

Implementation of nessai: nested sampling with artificial intelligence in PyTorch.

Installation

nessai-torch can be install using pip:

pip install nessai-torch

We recommend installing PyTorch first to ensure the version is compatible with your system.

Basic usage

nessai-torch has a different API to nessai, the user must define a log-likelihood function and a prior-transform function instead of a model object. It also has a reduced feature set compared to standard nessai. The basic usage is shown below, for a more complete example, see the examples directory.

from nessai_torch.sampler import Sampler

# Define the log-likelihood and prior transform
...

sampler = Sampler(
	log_likelihood=log_likelihood_fn,
	prior_transform=prior_transform_fn,
	dims=dims,  # Number of dimensions
)

# Run the sampler
sampler.run()

Note that both the log_likelihood and prior_transform must be vectorized.

Citing

If you use nessai-torch in your work please cite the DOI and the relevant papers:

@article{Williams_2021,
	doi = {10.1103/physrevd.103.103006},
	url = {https://doi.org/10.1103%2Fphysrevd.103.103006},
	year = 2021,
	month = {may},
	publisher = {American Physical Society ({APS})},
	volume = {103},
	number = {10},
	author = {Michael J. Williams and John Veitch and Chris Messenger},
	title = {Nested sampling with normalizing flows for gravitational-wave inference},
	journal = {Physical Review D}
}

@article{Williams_2023,
	doi = {10.1088/2632-2153/acd5aa},
	url = {https://doi.org/10.1088%2F2632-2153%2Facd5aa},
	year = 2023,
	month = {jul},
	publisher = {{IOP} Publishing},
	volume = {4},
	number = {3},
	pages = {035011},
	author = {Michael J. Williams and John Veitch and Chris Messenger},
	title = {Importance nested sampling with normalising flows},
	journal = {Machine Learning: Science and Technology}
}

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_torch-0.1.0.tar.gz (24.2 kB view details)

Uploaded Source

Built Distribution

nessai_torch-0.1.0-py3-none-any.whl (22.8 kB view details)

Uploaded Python 3

File details

Details for the file nessai_torch-0.1.0.tar.gz.

File metadata

  • Download URL: nessai_torch-0.1.0.tar.gz
  • Upload date:
  • Size: 24.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for nessai_torch-0.1.0.tar.gz
Algorithm Hash digest
SHA256 202a31497402c1efb4b221501db7d3584ac793926164dd5aad0743b23baed79f
MD5 98816d6a4d68f5222c6c3c54a9004f4c
BLAKE2b-256 eee75f29deef0a67251de421fca35c0c26bdd427f474f99fd4402e7d3058c32e

See more details on using hashes here.

File details

Details for the file nessai_torch-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: nessai_torch-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 22.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for nessai_torch-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9f3c30b1ad43752c99861c814fc74a06efa71c43c466b4d8c38a1edb2c5a3124
MD5 dadd0d593057b130196abcd11cc1d563
BLAKE2b-256 8b56711c979700b9ccbb80fb48922470621d6358f37d5816ee14a7cd51fdc97c

See more details on using hashes here.

Supported by

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