Skip to content

Commit 2998cfe

Browse files
esantorellafacebook-github-bot
authored andcommitted
Deduplicate getting started (#1613)
Summary: ## Motivation * We shouldn't recommend installing from pip without a lot of caveats since this won't work well on OSX, as explained in the README * It's best to not repeat information on version numbers, etc. in too many places; we should treat the README as the source of truth on installation instructions. Any install instructions other than the README should be brief and not misleading. Pull Request resolved: #1613 Test Plan: * Looked at the changed files in a Markdown viewer * Built the website and looked at the changed pages: <img width="1511" alt="image" src="https://user-images.githubusercontent.com/9137425/210680146-976d6e29-cfdb-4f18-9e23-f37d8ce842c2.png"> <img width="888" alt="image" src="https://user-images.githubusercontent.com/9137425/210680184-d2053526-1c01-4069-8b2f-4945dcf38ba2.png"> Reviewed By: Balandat Differential Revision: D42354941 Pulled By: esantorella fbshipit-source-id: f01e8d3d676bde7a35450b928e2de20267e544c3
1 parent b6c7a2b commit 2998cfe

File tree

2 files changed

+4
-12
lines changed

2 files changed

+4
-12
lines changed

docs/getting_started.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,12 @@ Before jumping the gun, we recommend you start with the high-level
1313

1414
#### Installation Requirements:
1515

16-
- Python >= 3.8
17-
- PyTorch >= 1.11
18-
- gpytorch == 1.9.1
19-
- linear_operator == 0.3.0
20-
- scipy
21-
- multiple-dispatch
22-
- pyro-ppl >= 1.8.4
23-
2416
BoTorch is easily installed via
25-
[Anaconda](https://www.anaconda.com/distribution/#download-section) (recommended)
17+
[Anaconda](https://www.anaconda.com/distribution/#download-section) (strongly recommended for OSX)
2618
or `pip`:
2719

2820
<!--DOCUSAURUS_CODE_TABS-->
29-
<!--conda-->
21+
<!--Conda-->
3022
```bash
3123
conda install botorch -c pytorch -c gpytorch -c conda-forge
3224
```
@@ -36,7 +28,7 @@ pip install botorch
3628
```
3729
<!--END_DOCUSAURUS_CODE_TABS-->
3830

39-
For more detailed installation instructions, please see the
31+
For more installation options and detailed instructions, please see the
4032
[Project Readme](https://github.com/pytorch/botorch/blob/main/README.md)
4133
on GitHub.
4234

website/pages/en/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ candidate # tensor([0.4887, 0.5063])
164164
<ol>
165165
<li>
166166
<h4>Install BoTorch:</h4>
167-
<a>via conda (recommended):</a>
167+
<a>via Conda (strongly recommended for OSX):</a>
168168
<MarkdownBlock>{bash`conda install botorch -c pytorch -c gpytorch -c conda-forge`}</MarkdownBlock>
169169
<a>via pip:</a>
170170
<MarkdownBlock>{bash`pip install botorch`}</MarkdownBlock>

0 commit comments

Comments
 (0)