You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Dec 18, 2023. It is now read-only.
Summary: Fixes to be consistent with the instructions in our git repository
Reviewed By: jpchen
Differential Revision: D33025599
fbshipit-source-id: 7317bdb140d498e67cd8502d13205224af383a68
Copy file name to clipboardExpand all lines: docs/overview/installation/installation.md
+15-9Lines changed: 15 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,22 +6,28 @@ sidebar_label: 'Installation'
6
6
<!-- @import "../../header.md" -->
7
7
8
8
## 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.
10
10
11
11
## Requirements
12
-
... [TODO: Add instructions]
12
+
Python 3.7-3.8 and PyTorch 1.10.
13
13
14
-
## Installation
14
+
Note: Some features are not yet supported on Python 3.9+
15
15
16
-
Bean Machine can be built from the source available on GitHub or installed directly using PIP or conda.
16
+
## Latest Release
17
17
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:
21
19
```
22
20
pip install beanmachine
23
21
```
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:
0 commit comments