Skip to content

Commit 01b62a2

Browse files
Update comments in demo notebooks
1 parent 70d453d commit 01b62a2

File tree

6 files changed

+25
-10
lines changed

6 files changed

+25
-10
lines changed

demo-notebooks/guided-demos/0_basic_ray.ipynb

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
"id": "12eef53c",
8989
"metadata": {},
9090
"source": [
91-
"Next, we want to bring our cluster up, so we call the `up()` function below to submit our Ray Cluster onto the queue, and begin the process of obtaining our resource cluster."
91+
"To create the Ray Cluster, we can click the `Cluster Up` button to submit our Ray Cluster onto the queue, and begin the process of creating a Ray Cluster resource. Alternatively, you can run the code cell below to do the same."
9292
]
9393
},
9494
{

demo-notebooks/guided-demos/1_cluster_job_client.ipynb

+7
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,13 @@
7676
"))"
7777
]
7878
},
79+
{
80+
"cell_type": "markdown",
81+
"metadata": {},
82+
"source": [
83+
"To create the Ray Cluster, we can tick the `Wait for cluster?` checkbox and click the `Cluster Up` button to submit our Ray Cluster onto the queue, and begin the process of creating a Ray Cluster resource while waiting for the Ray Dashboard to be available. Alternatively, you can run the code cell below to do the same."
84+
]
85+
},
7986
{
8087
"cell_type": "code",
8188
"execution_count": null,

demo-notebooks/guided-demos/2_basic_interactive.ipynb

+8
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,14 @@
8181
"))"
8282
]
8383
},
84+
{
85+
"cell_type": "markdown",
86+
"id": "6973247b",
87+
"metadata": {},
88+
"source": [
89+
"To create the Ray Cluster, we can tick the `Wait for cluster?` checkbox and click the `Cluster Up` button to submit our Ray Cluster onto the queue, and begin the process of creating a Ray Cluster resource while waiting for the Ray Dashboard to be available. Alternatively, you can run the code cell below to do the same."
90+
]
91+
},
8492
{
8593
"cell_type": "code",
8694
"execution_count": null,

demo-notebooks/guided-demos/3_widget_example.ipynb

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@
6565
"# Create and configure our cluster object\n",
6666
"# The SDK will try to find the name of your default local queue based on the annotation \"kueue.x-k8s.io/default-queue\": \"true\" unless you specify the local queue manually below\n",
6767
"cluster = Cluster(ClusterConfiguration(\n",
68-
" name='raytest',\n",
68+
" name='widgettest',\n",
6969
" head_cpu_requests='500m',\n",
7070
" head_cpu_limits='500m',\n",
7171
" head_memory_requests=2,\n",

ui-tests/tests/widget_notebook_example.test.ts

+8-8
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ test.describe("Visual Regression", () => {
8888
await interactWithWidget(page, upDownWidgetCellIndex, 'button:has-text("Cluster Up")', async (button) => {
8989
await button.click();
9090

91-
const successMessage = await page.waitForSelector('text=Ray Cluster: \'raytest\' has successfully been created', { timeout: 10000 });
91+
const successMessage = await page.waitForSelector('text=Ray Cluster: \'widgettest\' has successfully been created', { timeout: 10000 });
9292
expect(successMessage).not.toBeNull();
9393

9494
const resourcesMessage = await page.waitForSelector('text=Waiting for requested resources to be set up...');
@@ -105,20 +105,20 @@ test.describe("Visual Regression", () => {
105105

106106
await interactWithWidget(page, upDownWidgetCellIndex, 'button:has-text("Cluster Down")', async (button) => {
107107
await button.click();
108-
const clusterDownMessage = await page.waitForSelector('text=Ray Cluster: \'raytest\' has successfully been deleted', { timeout: 5000 });
108+
const clusterDownMessage = await page.waitForSelector('text=Ray Cluster: \'widgettest\' has successfully been deleted', { timeout: 5000 });
109109
expect(clusterDownMessage).not.toBeNull();
110110
});
111111

112112
await runPreviousCell(page, cellCount, '(<CodeFlareClusterStatus.UNKNOWN: 6>, False)');
113113

114114
// Replace text in ClusterConfiguration to run a new RayCluster
115-
const cell = page.getByText('raytest').first();
116-
await cell.fill('"raytest-1"');
115+
const cell = page.getByText('widgettest').first();
116+
await cell.fill('"widgettest-1"');
117117
await page.notebook.runCell(cellCount - 3, true); // Run ClusterConfiguration cell
118118

119119
await interactWithWidget(page, upDownWidgetCellIndex, 'button:has-text("Cluster Up")', async (button) => {
120120
await button.click();
121-
const successMessage = await page.waitForSelector('text=Ray Cluster: \'raytest-1\' has successfully been created', { timeout: 10000 });
121+
const successMessage = await page.waitForSelector('text=Ray Cluster: \'widgettest-1\' has successfully been created', { timeout: 10000 });
122122
expect(successMessage).not.toBeNull();
123123
});
124124

@@ -146,13 +146,13 @@ test.describe("Visual Regression", () => {
146146

147147
await interactWithWidget(page, viewClustersCellIndex, 'button:has-text("Open Ray Dashboard")', async (button) => {
148148
await button.click();
149-
const successMessage = await page.waitForSelector('text=Opening Ray Dashboard for raytest-1 cluster', { timeout: 5000 });
149+
const successMessage = await page.waitForSelector('text=Opening Ray Dashboard for widgettest-1 cluster', { timeout: 5000 });
150150
expect(successMessage).not.toBeNull();
151151
});
152152

153153
await interactWithWidget(page, viewClustersCellIndex, 'button:has-text("View Jobs")', async (button) => {
154154
await button.click();
155-
const successMessage = await page.waitForSelector('text=Opening Ray Jobs Dashboard for raytest-1 cluster', { timeout: 5000 });
155+
const successMessage = await page.waitForSelector('text=Opening Ray Jobs Dashboard for widgettest-1 cluster', { timeout: 5000 });
156156
expect(successMessage).not.toBeNull();
157157
});
158158

@@ -161,7 +161,7 @@ test.describe("Visual Regression", () => {
161161

162162
const noClustersMessage = await page.waitForSelector(`text=No clusters found in the ${namespace} namespace.`, { timeout: 5000 });
163163
expect(noClustersMessage).not.toBeNull();
164-
const successMessage = await page.waitForSelector(`text=Cluster raytest-1 in the ${namespace} namespace was deleted successfully.`, { timeout: 5000 });
164+
const successMessage = await page.waitForSelector(`text=Cluster widgettest-1 in the ${namespace} namespace was deleted successfully.`, { timeout: 5000 });
165165
expect(successMessage).not.toBeNull();
166166
});
167167

Loading

0 commit comments

Comments
 (0)