Skip to content

Docs: clarify installation instructions for v2 #387

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Apr 7, 2025
Merged

Docs: clarify installation instructions for v2 #387

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,16 @@ More tutorials are always welcome! Please consider making a pull request if you

## Install

BayesFlow is available to install via pip:
BayesFlow v2 is not yet installable via PyPI, but you can use the following command to install the latest version of the `main` branch:

```bash
pip install bayesflow
pip install git+https://github.com/bayesflow-org/bayesflow.git
```

If you encounter problems with this or require more control, please refer to the instructions to install from source below.

Note: `pip install bayesflow` will install the v1 version of BayesFlow.

### Backend

To use BayesFlow, you will also need to install one of the following machine learning backends.
Expand Down
4 changes: 1 addition & 3 deletions docsrc/source/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,7 @@ More tutorials are always welcome! Please consider making a pull request if you

.. tab-item:: pip

.. code-block:: bash

pip install bayesflow
The v2 version is not available on PyPI yet, please install from source.

.. tab-item:: source

Expand Down