From b151656d333e1515e60eea79d8f72f4e47c0f038 Mon Sep 17 00:00:00 2001 From: Max Balandat Date: Thu, 7 Nov 2024 08:46:52 -0800 Subject: [PATCH] Update copy to make conda instructions less prominent --- README.md | 17 ++++------------- docs/getting_started.md | 5 +++-- website/pages/en/index.js | 4 ++-- 3 files changed, 9 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index b031ade79c..b8420ff4b3 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,6 @@ [![Nightly](https://github.com/pytorch/botorch/actions/workflows/nightly.yml/badge.svg)](https://github.com/pytorch/botorch/actions?query=workflow%3ANightly) [![Codecov](https://img.shields.io/codecov/c/github/pytorch/botorch.svg)](https://codecov.io/github/pytorch/botorch) -[![Conda](https://img.shields.io/conda/v/conda-forge/botorch.svg)](https://anaconda.org/conda-forge/botorch) [![PyPI](https://img.shields.io/pypi/v/botorch.svg)](https://pypi.org/project/botorch) [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE) @@ -66,10 +65,7 @@ Optimization simply use Ax. ### Option 1: Installing the latest release -The latest release of BoTorch is easily installed either via pip (recommended) -or [Anaconda](https://www.anaconda.com/distribution/#download-section). - -**To install with `pip` (recommended)**, run +The latest release of BoTorch is easily installed via `pip`: ```bash pip install botorch @@ -78,18 +74,13 @@ pip install botorch _Note_: Make sure the `pip` being used is actually the one from the newly created Conda environment. If you're using a Unix-based OS, you can use `which pip` to check. - -**Alternatively, to install BoTorch from Anaconda**, run +BoTorch [stopped publishing](https://github.com/pytorch/botorch/discussions/2613#discussion-7431533) +an official Anaconda package to the `pytorch` channel after the 0.12 release. However, +users can still use the package published to the `conda-forge` channel and install botorch via ```bash conda install botorch -c gpytorch -c conda-forge ``` -The above command installs BoTorch and any needed dependencies. -` -c gpytorch -c conda-forge` means that the most preferred source to install from is -the `-gpytorch` channel, the next most preferred is the `conda-forge` channel. -_Note_: BoTorch [stopped publishing](https://github.com/pytorch/botorch/discussions/2613#discussion-7431533) -an official anaconda package to the `pytorch` channel after the 0.12 release. However, -you can still use the package published to the `conda-forge` channel. ### Option 2: Installing from latest main branch diff --git a/docs/getting_started.md b/docs/getting_started.md index 8b3fa1493d..a17f0f5e02 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -13,8 +13,9 @@ Before jumping the gun, we recommend you start with the high-level #### Installation Requirements: -BoTorch is easily installed via `pip` (recommended) or -[Anaconda](https://www.anaconda.com/distribution/#download-section): +BoTorch is easily installed via `pip` (recommended). It is also possible to +use the (unofficial) [Anaconda](https://www.anaconda.com/distribution/#download-section) +package from the `-c conda-forge` channel. diff --git a/website/pages/en/index.js b/website/pages/en/index.js index fb2cfa5695..9d7e5d151f 100755 --- a/website/pages/en/index.js +++ b/website/pages/en/index.js @@ -168,9 +168,9 @@ candidate # tensor([[0.2981, 0.2401]], dtype=torch.float64)

  1. Install BoTorch:

    - via pip(recommended): + via pip (recommended): {bash`pip install botorch`} - via pip: + via Anaconda (from the unofficial conda-forge channel): {bash`conda install botorch -c gpytorch -c conda-forge`}