Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[docs] copy edits and clarify instructions to get to Jobs screenshot #154

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[docs] copy edits and clarify instructions to get to Jobs screenshot #154

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 27 additions & 27 deletions templates/intro-workspaces/README.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@
"\n",
"**⏱️ Time to complete**: 10 min\n",
"\n",
"Welcome! You are currently in a Workspace, which is a persistent cloud IDE connected to a Ray cluster.\n",
"Welcome! You are currently in a Workspace, which is a persistent cloud IDE connected to a Ray Cluster.\n",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be lowercase, per https://docs.ray.io/en/latest/cluster/getting-started.html

"\n",
"In this tutorial, you will learn:\n",
"1. Basic workspace features such as git repo persistence, cloud storage, and SSH authentication.\n",
"2. Ray cluster management features, such as adding multiple worker nodes.\n",
"3. Ray monitoring features such as viewing tasks in the dashboard.\n",
"1. Basic workspace features such as Git repo persistence, cloud storage, and SSH authentication.\n",
"2. Ray Cluster management features, such as adding multiple worker nodes.\n",
"3. Ray monitoring features such as viewing tasks in the Dashboard.\n",
"4. Dependency management.\n",
"\n",
"## \"Hello world\" in workspaces\n",
"## \"Hello world\" in Workspaces\n",
"\n",
"Let's start by checking that Ray is working properly in your workspace. You can do this by running the following cell to execute a simple parallel Ray program."
"Start by checking that Ray is working properly in your Workspace. Run the following cell to execute a simple parallel Ray program."
]
},
{
Expand All @@ -42,11 +42,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Workspace Basics\n",
"## Workspace basics\n",
"\n",
"An Anyscale Workspace is a cloud IDE where you can develop and test Ray programs. Let's get started by creating a new git repo in this workspace. Workspaces will persist the tracked files in this git repo across restarts (as well as files not in a git repos).\n",
"An Anyscale Workspace is a cloud IDE where you can develop and test Ray programs. Start by creating a new Git repo in this workspace. Workspaces will persist the tracked files in this Git repo across restarts (as well as files not in a Git repos).\n",
"\n",
"We'll use the repo later on to author and run a simple Ray app."
"You can use the same repo later on to author and run a simple Ray app."
]
},
{
Expand Down Expand Up @@ -84,9 +84,9 @@
"source": [
"### Cloud Storage\n",
"\n",
"Workspace local storage is limited to 1GB, so we recommend only using it to store git repos and smaller files. To persist larger files, you can save data to cloud storage.\n",
"Because Workspace local storage is limited to 1GB, use it to store Git repos and smaller files. To persist larger files, you can save data to cloud storage.\n",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"Because Workspace local storage is limited to 1GB, use it to store Git repos and smaller files. To persist larger files, you can save data to cloud storage.\n",
"Because workspace local storage is limited to 1GB, use it to store Git repos and smaller files. To persist larger files, you can save data to cloud storage.\n",

I believe we are standardizing on lowercase for workspace, per previous discussions. It's only capital when introduced in the context of "Anyscale Workspace".

"\n",
"Cloud storage can be read and written from the workspace, as well as from any node in the Ray cluster.\n",
"Cloud storage can be read and written from the Workspace, as well as from any node in the Ray Cluster.\n",
"\n",
"Access built-in cloud storage using the `$ANYSCALE_ARTIFACT_STORAGE` URI as a prefix:"
]
Expand Down Expand Up @@ -115,7 +115,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Ray cluster management"
"## Ray Cluster management"
]
},
{
Expand All @@ -128,23 +128,23 @@
"\n",
"### Configuring the Workspace node\n",
"\n",
"The workspace node is the machine this notebook is running inside. You may wish to change the instance type of the workspace node specifically, e.g., to increase the available memory or add a GPU. Click the pencil icon in order to change the workspace node. Note that changing the workspace node will restart the workspace IDE.\n",
"The workspace node is the machine this notebook is running inside. You may wish to change the instance type of the workspace node specifically, e.g., to increase the available memory or add a GPU. Click the pencil icon in order to change the workspace node. Note that changing the workspace node restarts the workspace IDE.\n",
"\n",
"<img src=\"assets/edit-workspace-node.png\" height=300px/>\n",
"<img src=\"assets/edit-workspace-dialog.png\" width=400px/>\n",
"\n",
"### Adding worker nodes\n",
"\n",
"To parallelize beyond the resources available to the workspace node, add additional worker nodes to the Ray cluster. Click \"Add a node type\" to add a number of nodes of a certain type to the cluster. While most use cases only require a single worker node type, you can add multiple distinct node types (e.g., high-CPU and GPU nodes) to the workspace as well.\n",
"To parallelize beyond the resources available to the workspace node, add additional worker nodes to the Ray Cluster. Click \"Add a node type\" to add a number of nodes of a certain type to the Cluster. While most use cases only require a single worker node type, you can add multiple distinct node types (e.g., high-CPU and GPU nodes) to the Workspace as well.\n",
"\n",
"<img src=\"assets/add-node-type.png\" height=300px/>\n",
"<img src=\"assets/add-node-dialog.png\" height=300px/>\n",
"\n",
"### Using \"Auto-select workers\" mode\n",
"\n",
"To let Ray automatically select what kind of worker nodes to add to the cluster, check the \"Auto-select workers\" box. Ray will add worker nodes as needed to run submitted tasks and actors. In auto mode, you cannot configure workers, but the resources panel will show which nodes have been launched.\n",
"To let Ray automatically select what kind of worker nodes to add to the cluster, check the \"Auto-select workers\" box. Ray adds worker nodes as needed to run submitted tasks and actors. In auto mode, you can't configure workers, but the resources panel shows which nodes have been launched.\n",
"\n",
"We recommend using auto mode if you do not have specific cluster requirements, and are ok with waiting for the autoscaler to add nodes on-demand to the cluster."
"Use auto mode if you don't have specific cluster requirements, and are ok with waiting for the autoscaler to add nodes on-demand to the Cluster."
]
},
{
Expand All @@ -153,7 +153,7 @@
"source": [
"## Monitoring Ray applications\n",
"\n",
"In this section, we'll author a simple Ray python script and go over the tools available to monitor its execution. Let's take the opportunity to create a `my_app.py` file in the `my_repo` git repo you created earlier.\n",
"In this section, we'll author a simple Ray python script and go over the tools available to monitor its execution. Let's take the opportunity to create a `my_app.py` file in the `my_repo` Git repo you created earlier.\n",
"\n",
"You can click on the \"File Explorer\" in the left pane of VSCode to create the new file. Copy paste the following program into the file:\n",
"\n",
Expand Down Expand Up @@ -187,7 +187,7 @@
"source": [
"### Understanding Ray log output\n",
"\n",
"After running `my_app.py`, you should see output of the form `(do_some_work pid=29848) Doing work [repeated 4x across cluster]`. The prefix of the log message shows the function name, PID of the worker that ran the function, and if run on a remote worker, the node IP.\n",
"After running `my_app.py`, you should see output of the form `(do_some_work pid=29848) Doing work [repeated nx across cluster]`. The prefix of the log message shows the function name, PID of the worker that ran the function, and if run on a remote worker, the node IP.\n",
"\n",
"The result of the log message contains stdout and stderr from the function execution. Ray will also deduplicate repetitive logs from parallel execution of functions across the cluster."
]
Expand All @@ -210,19 +210,19 @@
"\n",
"**Ray dashboard > Jobs**\n",
"\n",
"To see the status of an active or previously run Ray job, navigate to `Ray Dashboard > Jobs` in the UI. Here you will see an overview of job progress, logs, and the ability to drill down into individual task and actors.\n",
"To see the status of an active or previously run Ray Job, navigate to `Ray Dashboard > Jobs` in the UI. You can see an overview of Job progress, logs, and have the ability to drill down into individual task and actors. Double-click on one of the Jobs to see a screenshot like the following:\n",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"To see the status of an active or previously run Ray Job, navigate to `Ray Dashboard > Jobs` in the UI. You can see an overview of Job progress, logs, and have the ability to drill down into individual task and actors. Double-click on one of the Jobs to see a screenshot like the following:\n",
"To see the status of an active or previously run Ray Job, navigate to `Ray Dashboard > Jobs` in the UI. You can see an overview of Job progress, logs, and have the ability to drill down into individual task and actors. Click on one of the Jobs to see a screenshot like the following:\n",

You don't need to double-click. Single-click is enough

"\n",
"<img src=\"assets/ray-dashboard-jobs.png\" height=400px/>\n",
"\n",
"**Ray dashboard > Metrics**\n",
"**Ray Dashboard > Metrics**\n",
"\n",
"View the aggregate time-series metrics for the cluster in order to diagnose job execution efficiency. The `Ray Dashboard > Metrics` page offers metrics on Ray tasks, actors, as well as hardware resource utilization of the cluster.\n",
"View the aggregate time-series metrics for the cluster in order to diagnose job execution efficiency. The `Ray Dashboard > Metrics` page offers metrics on Ray tasks, actors, as well as hardware resource utilization of the Cluster.\n",
"\n",
"<img src=\"assets/ray-dashboard-metrics.png\" height=400px/>\n",
"\n",
"**Logs Tab**\n",
"\n",
"View and search over Ray cluster and application logs in the Logs tab.\n",
"View and search over Ray Cluster and application logs in the Logs tab.\n",
"\n",
"<img src=\"assets/logs-tab.png\" height=400px/>"
]
Expand All @@ -231,11 +231,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Dependency Management\n",
"## Dependency management\n",
"\n",
"In order to run code across a cluster, Ray ships code and other library dependencies to other machines in [runtime envs](https://docs.ray.io/en/latest/ray-core/handling-dependencies.html). In workspaces, the code and installed PyPI packages are automatically added to the runtime env to be used by Ray.\n",
"In order to run code across a Cluster, Ray ships code and other library dependencies to other machines in [runtime envs](https://docs.ray.io/en/latest/ray-core/handling-dependencies.html). In Workspaces, the code and installed PyPI packages are automatically added to the runtime env to be used by Ray.\n",
"\n",
"To try this out, run the following command to install the `emoji` package. You'll see a notification that the package has been registered with the cluster."
"To try this out, run the following command to install the `emoji` package. Look for a notification that the package has been registered with the Cluster."
]
},
{
Expand All @@ -251,11 +251,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Navigate to the `Dependencies` tab of the workspace, and you should see the `emoji` package in the list there. You can use this UI to edit the workspace runtime dependencies, or the UI.\n",
"Navigate to the `Dependencies` tab of the Workspace, and you should see the `emoji` package in the list there. You can use this UI to edit the Workspace runtime dependencies, or the UI.\n",
"\n",
"<img src=\"assets/dependencies-tab.png\" height=400px/>\n",
"\n",
"Run the following cell to check that the `emoji` package is successfully installed on the cluster (to check this properly, make sure the cluster has at least one worker node added)."
"Run the following cell to check that the `emoji` package is successfully installed on the cluster. To check this properly, make sure the Cluster has at least one worker node added."
]
},
{
Expand Down
Loading