Skip to content

Commit

Permalink
Update copy to make conda instructions less prominent
Browse files Browse the repository at this point in the history
  • Loading branch information
Balandat committed Nov 7, 2024
1 parent c2b1497 commit b151656
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 17 deletions.
17 changes: 4 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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
Expand All @@ -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

Expand Down
5 changes: 3 additions & 2 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<!--DOCUSAURUS_CODE_TABS-->
<!--pip-->
Expand Down
4 changes: 2 additions & 2 deletions website/pages/en/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -168,9 +168,9 @@ candidate # tensor([[0.2981, 0.2401]], dtype=torch.float64)
<ol>
<li>
<h4>Install BoTorch:</h4>
<a>via pip(recommended):</a>
<a>via pip (recommended):</a>
<MarkdownBlock>{bash`pip install botorch`}</MarkdownBlock>
<a>via pip:</a>
<a>via Anaconda (from the unofficial conda-forge channel):</a>
<MarkdownBlock>{bash`conda install botorch -c gpytorch -c conda-forge`}</MarkdownBlock>
</li>
<li>
Expand Down

0 comments on commit b151656

Please sign in to comment.