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
Copy file name to clipboardExpand all lines: README.md
+53-12Lines changed: 53 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,27 +28,43 @@ However, consider cloning or downloading a release of the tutorial notebooks and
28
28
29
29
## Setup for a Local Machine
30
30
31
-
> **WARNING:** Ray does not currently run on Windows (we're close...). [Contact Anyscale](mailto:[email protected]) for a free hosted option.
31
+
> **Note:** Ray support for Windows is experimental. See [these release notes](https://github.com/ray-project/ray/releases/tag/ray-0.8.6) for details. Alternatively, [Contact Anyscale](mailto:[email protected]) for a free hosted option for these tutorials.
32
32
33
-
If you are using MacOS or Linux, follow these instructions. Note that the setup commands can take a while to finish.
33
+
Follow these instructions to use the tutorials. Note that some commands can take a while to finish.
34
34
35
35
Clone the [Academy GitHub repo](https://github.com/anyscale/academy) or [download the latest release](https://github.com/anyscale/academy/releases).
36
36
37
37
Now install the dependencies using either [Anaconda](https://www.anaconda.com/) or `pip` in your Python environment. We recommend using Anaconda.
38
38
39
+
### Which Python Version?
40
+
41
+
Python 3.7 is recommended. While Ray supports Python 3.6, a user reported a problem using _locales_. Specifically, the following code throws an error:
This tutorial doesn't use _locales_ specifically, but you may run into problems with your default locale.
49
+
50
+
While Ray supports Python 3.8, some dependencies used in `RLlib` (the Ray reinforcement library) are not yet supported for 3.8, at the time of this writing.
51
+
52
+
39
53
### Using Anaconda
40
54
41
55
If you need to install Anaconda, follow the instructions [here](https://www.anaconda.com/distribution/). If you already have Anaconda installed, consider running `conda upgrade --all`.
42
56
43
-
Run the following commands in the root directory of this project. First, use `conda` to install the other dependencies, including Ray. Then activate the newly-created environment, named `anyscale-academy`. Finally, run a provided script to install a graphing library extension in Jupyter Lab and perform other tasks.
57
+
Run the following commands in the root directory of this project. First, use `conda` to install the other dependencies, including Ray. Then activate the newly-created environment, named `anyscale-academy`. Finally, run the provided`tools/fix-jupyter.sh` script to install a graphing library extension in Jupyter Lab and perform other tasks.
44
58
45
59
```shell
46
60
conda env create -f environment.yml
47
61
conda activate anyscale-academy
48
62
tools/fix-jupyter.sh
49
63
```
50
64
51
-
Note that Python 3.7 is used. While Ray supports Python 3.8, some dependencies used in `RLlib` (the Ray reinforcement library) are not yet supported for 3.8.
65
+
If you are using Windows, see the _Fixing Jupyter Lab on Windows_ section below for an alternative to using `tools/fix-jupyter.sh`.
66
+
67
+
Note that Python 3.7 is used.
52
68
53
69
You can delete the environment later with the following command:
If you don't use Anaconda, you'll have to install these prerequisites first:
62
78
63
-
* Python 3.6 or 3.7: While Ray supports Python 3.8, some dependencies used in `RLlib` (the Ray reinforcement library) and other dependencies are not yet supported for 3.8.
79
+
* Python 3.7:
80
+
* See notes above about problems with 3.6 and 3.8. Don't use 3.8, but 3.6 may work for you.
64
81
* The version of Python that comes with your operating system is probably too old. Try `python --version` to see what you have.
65
82
* Installation instructions are at [python.org](https://www.python.org/downloads/).
66
83
* Pip: A recent version - consider upgrading if it's not the latest version.
67
84
* Installation instructions are at [pip.pypa.io](https://pip.pypa.io/en/stable/installing/).
68
85
* Node.js: Required for some of the Jupyter Lab graphics extensions we use.
69
86
* Installation instructions are [here](https://nodejs.org/en/).
70
87
71
-
Now run the following commands in the root directory of this project to complete the setup. First, run a`pip` command to install the rest of the libraries required for these tutorials, including Ray. Then, run a provided script to install a graphing library extension in Jupyter Lab and perform other tasks.
88
+
Next, run the following commands in the root directory of this project to complete the setup. First, run the`pip` command to install the rest of the libraries required for these tutorials, including Ray. Then, run the provided script to install a graphing library extension in Jupyter Lab and perform other tasks.
72
89
73
90
```shell
74
91
pip install -r requirements.txt
75
92
tools/fix-jupyter.sh
76
93
```
77
94
95
+
If you are using Windows, see the _Fixing Jupyter Lab on Windows_ section below for an alternative to using `tools/fix-jupyter.sh`.
96
+
97
+
### Fixing Jupyter Lab on Windows
98
+
99
+
The `tools/fix-jupyter.sh` shell script runs the following commands. If you are using Windows, run them yourself as shown here.
100
+
101
+
First, see if the following `pyviz` extension is installed:
The lessons will start a local Ray "cluster" (one node) on your machine. When you are finished with the tutorials, run the following command to shut down Ray:
123
+
The tutorials will start a local Ray "cluster" (one node) on your machine. When you are finished with the tutorials, run the following command to shut down Ray:
81
124
82
125
```shell
83
126
ray stop
84
127
```
85
128
86
129
Also, when you have finished working through the tutorials, run the script `tools/cleanup.sh`, which prints temporary files, checkpoints, etc. that were created during the lessons. You might want to remove these as they can add up to 100s of MBs.
87
130
88
-
If you decide to delete all the files and directories listed, the following script will do it:
131
+
If you decide to delete all the files and directories listed, the following `bash` command will do it:
89
132
90
133
```shell
91
134
tools/cleanup.sh |whileread x;do rm -rf $x;done
92
135
```
93
136
137
+
> **Note:** A Windows version of this script is TBD.
138
+
94
139
## Launching the Tutorials
95
140
96
141
The previous steps installed [Jupyter Lab](https://jupyterlab.readthedocs.io/en/stable/), the notebook-based environment we'll use for all the lessons. To start run the following command in the project root directory:
@@ -120,10 +165,6 @@ Here is a recommended reading list, based on your interests:
120
165
121
166
See the [Overview notebook](Overview.ipynb) for detailed, up-to-date descriptions for each tutorial and the lessons it contains.
122
167
123
-
## Notes
124
-
125
-
* We use Python 3.7, because a dependency of `RLlib`, `atari-py`, doesn't have a wheel available for Python 3.8 at this time.
126
-
127
168
## Troubleshooting
128
169
129
170
See the [Troubleshooting, Tips, and Tricks](reference/Troubleshooting-Tips-Tricks.ipynb) notebook.
0 commit comments