Skip to content

Commit

Permalink
docs: Add conda-forge install instructions
Browse files Browse the repository at this point in the history
* Add install instructions from conda-forge for pixi and conda.
* Add conda-forge badge.
  • Loading branch information
matthewfeickert committed Dec 20, 2024
1 parent 3b122e5 commit f19e7f7
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,31 @@
<a href="https://doi.org/10.5281/zenodo.4296287"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.4296287.svg" alt="DOI"></a>
<a href="https://github.com/bayesiains/nflows/actions/workflows/build_lint_test.yml"><img src="https://github.com/bayesiains/nflows/actions/workflows/build_lint_test.yml/badge.svg" alt="Build status"></a>
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-green.svg"></a>
<a href="https://anaconda.org/conda-forge/nflows"><img src="https://img.shields.io/conda/vn/conda-forge/nflows.svg"></a>

`nflows` is a comprehensive collection of [normalizing flows](https://arxiv.org/abs/1912.02762) using [PyTorch](https://pytorch.org).

## Installation

### From PyPI

To install from PyPI:
```
pip install nflows
python -m pip install nflows
```

### From conda-forge

To install and add `nflows` to a project with [`pixi`](https://pixi.sh/), from the project directory run

```
pixi add nflows
```

and to install into a particular conda environment with [`conda`](https://docs.conda.io/projects/conda/), in the activated environment run

```
conda install --channel conda-forge nflows
```

## Usage
Expand Down Expand Up @@ -82,7 +99,7 @@ If you're using spline-based flows in particular, consider citing the _Neural Sp
> [[arXiv]](https://arxiv.org/abs/1906.04032) [[bibtex]](https://papers.nips.cc/paper/2019/file/7ac71d433f282034e088473244df8c02-Bibtex.bib)

`nflows` has been used in
`nflows` has been used in
> Conor Durkan, Iain Murray, George Papamakarios, _On Contrastive Learning for Likelihood-free Inference_, ICML 2020.
> [[arXiv]](https://arxiv.org/abs/2002.03712).
Expand Down

0 comments on commit f19e7f7

Please sign in to comment.