From 423284c588019447c6f236b082295f237ca976ae Mon Sep 17 00:00:00 2001 From: Matthew Carbone Date: Tue, 2 Apr 2024 11:44:33 -0400 Subject: [PATCH] Update installation instructions on readme --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 793a3b3..4281f44 100644 --- a/README.md +++ b/README.md @@ -221,9 +221,17 @@ next_point_idx = obj.argmax() ## Installation If you would like to utilize a GPU acceleration, follow these [instructions](https://github.com/google/jax#installation) to install JAX with a GPU support. -Then, install GPax using pip: +Then, install GPax using pip. We recommend installing the latest stable deployment from PyPI using -```$ pip install git+https://github.com/ziatdinovmax/gpax``` +```bash +pip install gpax +``` + +Otherwise, if you are confident in what's on the `main` branch of GPax, you can also install directly from the GitHub repository: + +```bash +pip install git+https://github.com/ziatdinovmax/gpax +``` If you are a Windows user, we recommend to use the Windows Subsystem for Linux (WSL2), which comes free on Windows 10 and 11.