Refinements

Author: Dean Wampler

Overview.ipynb

@@ -30,7 +30,9 @@
     "* The [#tutorial channel](https://ray-distributed.slack.com/archives/C011ML23W5B) on the [Ray Slack](https://ray-distributed.slack.com)\n",
     "* [Email](mailto:[email protected])\n",
     "\n",
-    "Troubleshooting tips are offered in known areas where you might encounter issues. All are summarized in the [_Troubleshooting, Tips, and Tricks notebook_](reference/Troubleshooting-Tips-Tricks.ipynb). For the details of the Ray API and the ML libraries, see the [Ray Docs](https://docs.ray.io/en/latest/)."
+    "Troubleshooting tips are offered in known areas where you might encounter issues. All are summarized in the [_Troubleshooting, Tips, and Tricks notebook_](reference/Troubleshooting-Tips-Tricks.ipynb). For the details of the Ray API and the ML libraries, see the [Ray Docs](https://docs.ray.io/en/latest/).\n",
+    "\n",
+    "If you are new to Jupyter Lab and Jupyter Notebooks, see _Help > JupyterLab Reference_. The _Help_ menu also has references for Python and various libraries."
    ]
   },
   {

README.md

@@ -42,7 +42,7 @@ If you need to install Anaconda, follow the instructions [here](https://www.anac
 
 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.
 
-```
+```shell
 conda env create -f environment.yml
 conda activate anyscale-academy
 tools/fix-jupyter.sh
@@ -70,16 +70,24 @@ If you don't use Anaconda, you'll have to install these prerequisites first:
 
 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.
 
-```
+```shell
 pip install -r requirements.txt
 tools/fix-jupyter.sh
 ```
 
+## Final Notes for Local Installation
+
+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:
+
+```shell
+ray stop
+```
+
 ## Launching the Tutorials
 
 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:
 
-```
+```shell
 jupyter lab
 ```
 
@@ -106,7 +114,7 @@ See also the [_Troubleshooting, Tips, and Tricks notebook_](reference/Troublesho
 
 ### Tutorial Descriptions
 
-The [Overview notebook](Overview.ipynb) provides detailed, up-to-date descriptions for each tutorial and the lessons it contains.
+See the [Overview notebook](Overview.ipynb) for detailed, up-to-date descriptions for each tutorial and the lessons it contains.
 
 ## Notes
 

ray-crash-course/solutions/Ray-Crash-Course-Solutions.ipynb

@@ -649,7 +649,9 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "scrolled": true
+   },
    "outputs": [],
    "source": [
     "%time word_counts = count_words(['../*.ipynb'], top_n=100)  # The notebooks are now in the parent directory."

reference/Troubleshooting-Tips-Tricks.ipynb

@@ -62,7 +62,19 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## General Task and Actor Tips\n",
+    "## Tips and Tricks\n",
+    "\n",
+    "### Jupyter Tips\n",
+    "\n",
+    "* **Learning Jupyter Lab:** Open _Help > JupyerLab Reference_ for a user guide and detailed information about Jupyter Lab. The _Help_ menu has other references, too.\n",
+    "* **Excessive Output:** If the output of a cell is very long, right click on it and select _Enable Scrolling for Outputs_."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### General Task and Actor Tips\n",
     "\n",
     "* To create a task from a function or an actor from a class, annotate it with `@ray.remote`.\n",
     "* Invoke tasks with `foo.remote(...)`\n",
@@ -78,7 +90,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Using Existing Functions and Classes\n",
+    "#### Using Existing Functions and Classes\n",
     "\n",
     "An existing function can be used as a task by defining a new task function that calls the original function. For example:\n",
     "\n",
@@ -125,9 +137,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Using the Ray Dashboard\n",
+    "### Using the Ray Dashboard\n",
     "\n",
-    "### Opening the Dashboard\n",
+    "#### Opening the Dashboard\n",
     "\n",
     "As it executes, `ray.init` prints the dashboard URL.\n",
     "\n",
@@ -140,7 +152,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Profiling Actors\n",
+    "#### Profiling Actors\n",
     "\n",
     "The _Logical View_ offers a powerful and convenient way to profile actor performance using [flame graphs](http://www.brendangregg.com/flamegraphs.html). Details are in the [Dashboard docs](https://ray.readthedocs.io/en/latest/ray-dashboard.html#ray-dashboard).\n",
     "\n",
@@ -183,7 +195,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Profiling Code with ray.timeline()\n",
+    "### Profiling Code with ray.timeline()\n",
     "\n",
     "The other built-in way to profile performance uses `ray.timeline(file)` ([documentation](https://ray.readthedocs.io/en/latest/package-ref.html#ray.timeline)). It requires a Chrome web browser to view the data. This is the only way to profile tasks.\n",
     "\n",
@@ -203,7 +215,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Using Libraries\n",
+    "### Using Libraries\n",
     "\n",
     "If tasks or actors call (or subclass) library code in your project and that code isn't in a _subdirectory_ of the driver script, make sure that the process starting Ray has the correct `PYTHONPATH` set to the library location. For example,\n",
     "\n",
@@ -216,7 +228,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Cleaning Up\n",
+    "### Cleaning Up\n",
     "\n",
     "When your driver script exists, it will implicitly call `ray.shutdown()`. This can be useful to do explicitly if you want to restart Ray, for example, in a notebook environment. For example:\n",
     "\n",