Skip to main content

Neural Importance Sampling

Project description

ZüNIS: Normalizing flows for neural importance sampling

ZüNIS (Zürich Neural Importance Sampling) a work-in-progress Pytorch-based library for Monte-Carlo integration based on Neural imporance sampling [1], developed at ETH Zürich. In simple terms, we use artificial intelligence to compute integrals faster.

The goal is to provide a flexible library to integrate black-box functions with a level of automation comparable to the VEGAS Library [2], while using state-of-the-art methods that go around the limitations of existing tools.

Installation

Using pip

As the library is not yet fully mature, we have not released it to the Python Package Index (PyPI). You can nevertheless install it with pip from this repository as follows:

 pip install 'git+https://github.com/ndeutschmann/zunis#egg=zunis&subdirectory=zunis_lib'

Setting up a development environment

If you would like to contribute to the library, run the benchmarks or try the examples, the easiest is to clone this repository directly and install the extended requirements:

# Clone the repository
git clone https://github.com/ndeutschmann/zunis.git ./zunis
# Create a virtual environment (recommended)
python3.7 -m venv  zunis_venv
source ./zunis_venv/bin/activate
pip install --upgrade pip
# Install the requirements
cd ./zunis
pip install -r requirements.txt
# Run one benchmark (GPU highly recommended)
cd ./experiments/benchmarks
python benchmark_hypersphere.py

Library usage

For basic uses, a RealNVP-based integrator is provided with default choices and can be created and used as follows:

import torch
from src.integration import Integrator

device = torch.device("cuda")


d = 2

def f(x):
    return x[:,0]**2 + x[:,1]**2

integrator = Integrator(d=d,f=f,device=device)
result, uncertainty, history = integrator.integrate()

The function f is integrated over the d-dimensional unit hypercube and

  • takes torch.Tensor batched inputs with shape (N,d) for arbitrary batch size N on device
  • returns torch.Tensor batched inputs with shape (N,) for arbitrary batch size N on device

A more systematic documentation is under construction here.

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

zunis-0.tar.gz (35.8 kB view details)

Uploaded Source

Built Distribution

zunis-0-py3-none-any.whl (56.3 kB view details)

Uploaded Python 3

File details

Details for the file zunis-0.tar.gz.

File metadata

  • Download URL: zunis-0.tar.gz
  • Upload date:
  • Size: 35.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.6.9

File hashes

Hashes for zunis-0.tar.gz
Algorithm Hash digest
SHA256 caea482cf12631eaf667b5dbab85dc006a04555ab2a4162729b4fb96d239ed5e
MD5 40a27ed09307a60873d254b0f9efb706
BLAKE2b-256 e1854a9d81031778f80b922f164f8b18523d9b3aebdf1b084653419cb410407a

See more details on using hashes here.

File details

Details for the file zunis-0-py3-none-any.whl.

File metadata

  • Download URL: zunis-0-py3-none-any.whl
  • Upload date:
  • Size: 56.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.6.9

File hashes

Hashes for zunis-0-py3-none-any.whl
Algorithm Hash digest
SHA256 b266811c6b353a92400f5e58dc85754773dcc8b4d5d05a0d2a050552a5ea3e24
MD5 778565f1200c3806ac789937e213839e
BLAKE2b-256 27ede1840256f165b443f1b44732a289904897f86e02d03f2976084b2b332646

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