Skip to content
This repository was archived by the owner on Dec 18, 2023. It is now read-only.

Commit 1403420

Browse files
wtahafacebook-github-bot
authored andcommitted
Updates to installation.md
Summary: Fixes to be consistent with the instructions in our git repository Reviewed By: jpchen Differential Revision: D33025599 fbshipit-source-id: 7317bdb140d498e67cd8502d13205224af383a68
1 parent 3c0b5cd commit 1403420

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

docs/overview/installation/installation.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,28 @@ sidebar_label: 'Installation'
66
<!-- @import "../../header.md" -->
77

88
## Did You Check Out Colab?
9-
... [TODO[Brad]: Here we should have information about how easy it is to try our tool on Colab before installing it on own machine. Will also be good to put some links to this Colab at the top of the website's main tutorials.]
9+
The Google Colaboratory web service (Colab) is probably the quickest way to run Bean Machine. For example, [here is what our Coin Flipping tutorial looks like on Colab](https://colab.research.google.com/github/facebookresearch/beanmachine/blob/main/tutorials/Coin_flipping.ipynb). Similar links can be found for each of our tutorials in the Tutorials section.
1010

1111
## Requirements
12-
... [TODO: Add instructions]
12+
Python 3.7-3.8 and PyTorch 1.10.
1313

14-
## Installation
14+
Note: Some features are not yet supported on Python 3.9+
1515

16-
Bean Machine can be built from the source available on GitHub or installed directly using PIP or conda.
16+
## Latest Release
1717

18-
To build from source: ... [TODO: Add instructions]
19-
20-
[TODO: Check!] To install from source In can also be installed using PIP using the following command:
18+
Using `pip` you can get the latest release with the following command:
2119
```
2220
pip install beanmachine
2321
```
24-
[TODO: Check!]It can be installed using conda
22+
23+
## Installing From Source
24+
To install from source, the first step is to clone the git repository:
25+
```
26+
git clone https://github.com/facebookresearch/beanmachine.git
27+
cd beanmachine
28+
pip install -e .
29+
```
30+
If you are a developer and plan to experiment with modifying the code, we recommend replacing the last step above with:
2531
```
26-
conda install beanmachine -c pytorch
32+
pip install -e ".[dev]"
2733
```

0 commit comments

Comments
 (0)