Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md to include correct citation #46

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
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]](https://arxiv.org/abs/1808.03856), developed at ETH Zürich.
ZüNIS (Zürich Neural Importance Sampling)[[1]](https://arxiv.org/abs/2401.09069) a work-in-progress Pytorch-based library for Monte-Carlo integration
based on Neural imporance sampling [[2]](https://arxiv.org/abs/1808.03856), 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]](https://pypi.org/project/vegas/), while using state-of-the-art methods that go around
VEGAS Library [[3]](https://pypi.org/project/vegas/), while using state-of-the-art methods that go around
the limitations of existing tools.

If you are using ZüNIS, please cite arXiv:2401.09069.

## Installation

### Using `pip`
Expand Down Expand Up @@ -66,4 +68,4 @@ 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](https://zunis.readthedocs.io).
A more systematic documentation is under construction [here](https://zunis.readthedocs.io).