Skip to content

Commit 5dbad50

Browse files
authored
RHOAIENG-27677 - Address code rabbit feedback (#888)
1 parent bdaadd6 commit 5dbad50

9 files changed

+15
-15
lines changed

modules/about-workbench-images.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
= About workbench images
55

66
[role="_abstract"]
7-
A workbench image is optimized with the tools and libraries that you need for model development. You can use the provided workbench images or an {productname-short} administrator can create custom workbench images adapted to your needs.
7+
A workbench image is preinstalled with the tools and libraries that you need for model development. You can use the provided workbench images or an {productname-short} administrator can create custom workbench images adapted to your needs.
88

99
To provide a consistent, stable platform for your model development, many provided workbench images contain the same version of Python. Most workbench images available on {productname-short} are pre-built and ready for you to use immediately after {productname-short} is installed or upgraded.
1010

@@ -105,8 +105,8 @@ endif::[]
105105
| Use the ROCm workbench image to run AI and machine learning workloads on AMD GPUs in {productname-short}. It includes ROCm libraries and tools optimized for high-performance GPU acceleration, supporting custom AI workflows and data processing tasks. Use this image integrating additional frameworks or dependencies tailored to your specific AI development needs.
106106

107107
| ROCm-PyTorch
108-
| Use the ROCm-PyTorch workbench image to optimize PyTorch workloads on AMD GPUs in {productname-short}. It includes ROCm-accelerated PyTorch libraries, enabling efficient deep learning training, inference, and experimentation. This image is designed for data scientists working with PyTorch-based workflows, offering integration with GPU scheduling.
108+
| Use the ROCm-PyTorch workbench image to run PyTorch workloads on AMD GPUs in {productname-short}. It includes ROCm-accelerated PyTorch libraries, enabling efficient deep learning training, inference, and experimentation. This image is designed for data scientists working with PyTorch-based workflows, offering integration with GPU scheduling.
109109

110110
| ROCm-TensorFlow
111-
| Use the ROCm-TensorFlow workbench image to optimize TensorFlow workloads on AMD GPUs in {productname-short}. It includes ROCm-accelerated TensorFlow libraries to support high-performance deep learning model training and inference. This image simplifies TensorFlow development on AMD GPUs and integrates with {productname-short} for resource scaling and management.
111+
| Use the ROCm-TensorFlow workbench image to run TensorFlow workloads on AMD GPUs in {productname-short}. It includes ROCm-accelerated TensorFlow libraries to support high-performance deep learning model training and inference. This image simplifies TensorFlow development on AMD GPUs and integrates with {productname-short} for resource scaling and management.
112112
|===

modules/adding-workbench-pod-tolerations.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ endif::[]
4141

4242
.Verification
4343

44-
. In the {openshift-platform} console, for a pod that is running, click *Workloads* -> *Pods*. Otherwise, for a pod that is stopped, click *Workloads* -> *StatefulSet*.
44+
. In the {openshift-platform} console, select your data science project, then click *Workloads* -> *StatefulSet*. You can see how many pods are running, either zero or one, depending on whether your workbench is currently started or stopped.
4545
. Search for your workbench pod name and then click the name to open the pod details page.
4646
. Confirm that the assigned *Node* and *Tolerations* are correct.
4747

modules/configuring-the-default-pvc-size-for-your-cluster.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ To configure how resources are claimed within your {productname-short} cluster,
1313
.Prerequisites
1414
* You have logged in to {productname-short} as a user with {productname-short} administrator privileges.
1515

16-
NOTE: Changing the PVC setting restarts the workbench pod and makes Jupyter unavailable for up to 30 seconds. As a workaround, it is recommended that you perform this action outside of your organization's typical working day.
16+
NOTE: Changing the PVC setting restarts the workbench pod and makes it unavailable for up to 30 seconds. As a workaround, it is recommended that you perform this action outside of your organization's typical working day.
1717

1818
.Procedure
1919
. From the {productname-short} dashboard, click *Settings* -> *Cluster settings*.

modules/copying-files-between-buckets.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ To copy files between buckets in your object store from your workbench, use the
1313
* You know the key of the source file that you want to copy, and the bucket that the file is stored in.
1414

1515
.Procedure
16-
. In the notebook file, locate the following instructions to copy files between buckets:
16+
. In the notebook, locate the following instructions to copy files between buckets:
1717
+
1818
[source]
1919
----

modules/creating-a-custom-image-from-your-own-image.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ COPY --chmod=775 os-packages.txt ./
6868
WORKDIR /opt/app-root/src
6969
----
7070
+
71-
When a user launches a workbench from the {productname-short} *Applications* → *Enabled* page, the "personal" volume of the user is mounted at `/opt/app-root/src`. Because this location is not configurable, when you build your custom image, you must specify this default location for persisted data.
71+
When a user launches a workbench from the {productname-short} *Applications* → *Enabled* page, the personal volume of the user is mounted in the user's HOME directory (`/opt/app-root/src`). Because this location is not configurable, when you build your custom image, you must specify this default location for persisted data.
7272

7373
* Fix permissions to support PIP (the package manager for Python packages) in OpenShift environments. Add the following command to your custom image (if needed, change `python3.9` to the Python version that you are using):
7474
+

modules/creating-a-runtime-configuration.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ You can obtain the data science pipelines API endpoint from the *Data science pi
5151
+
5252
[IMPORTANT]
5353
====
54-
If you created a notebook directly from the *Start basic workbench* tile on the dashboard, select `EXISTING_BEARER_TOKEN` from the *Authentication Type* list.
54+
If you created a workbench directly from the *Start basic workbench* tile on the dashboard, select `EXISTING_BEARER_TOKEN` from the *Authentication Type* list.
5555
====
5656
... In the *Data Science Pipelines API Endpoint Username* field, enter the user name required for the authentication type.
5757
... In the *Data Science Pipelines API Endpoint Password Or Token*, enter the password or token required for the authentication type.

modules/starting-a-basic-workbench.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ endif::[]
3232
If your credentials are accepted, the *Workbench control panel* opens displaying the *Start a basic workbench* page.
3333
. Start a basic workbench.
3434

35-
.. In the *Workbench image* section, select the workbench image to use for your server.
35+
.. In the *Workbench image* section, select the workbench image to use for your workbench.
3636
+
3737
Different workbench images have different packages installed by default. Click the help icon (?) next to a workbench image name to view a list of its included packages.
3838

@@ -42,7 +42,7 @@ Different workbench images have different packages installed by default. Click t
4242
--
4343
When a new version of a workbench image is released, the previous version remains available and supported on the cluster. This gives you time to migrate your work to the latest version of the workbench image.
4444
--
45-
.. From the *Container size* list, select a suitable container size for your server.
45+
.. From the *Container size* list, select a suitable container size for your workbench.
4646
.. Optional: From the *Accelerator* list, select an accelerator.
4747
.. If you selected an accelerator in the preceding step, specify the number of accelerators to use.
4848
+

modules/troubleshooting-common-problems-in-workbenches-for-administrators.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,9 +120,9 @@ endif::[]
120120
* Work with the user to identify files that can be deleted from the `/opt/app-root/src` directory on their workbench to free up their existing storage space.
121121

122122
[NOTE]
123-
--
123+
====
124124
When you delete files using the JupyterLab file explorer, the files move to the hidden `/opt/app-root/src/.local/share/Trash/files` folder in the persistent storage for the workbench. To free up storage space for workbenches, you must permanently delete these files.
125-
--
125+
====
126126

127127
// [role='_additional-resources']
128128
// == Additional resources

modules/updating-your-project-with-changes-from-a-remote-git-repository.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
You can pull changes made by other users into your data science project from a remote Git repository.
88

99
.Prerequisites
10+
* You have a launched and running workbench based on a JupyterLab image.
11+
* You have credentials for logging in to Jupyter.
1012
* You have configured the remote Git repository.
11-
* You have imported the Git repository into JupyterLab, and the contents of the repository are visible in the file browser in JupyterLab.
1213
* You have permissions to pull files from the remote Git repository to your local repository.
13-
* You have credentials for logging in to Jupyter.
14-
* You have a launched and running workbench based on a JupyterLab image.
14+
* You have imported the Git repository into JupyterLab, and the contents of the repository are visible in the file browser in JupyterLab.
1515

1616
.Procedure
1717
. In the JupyterLab interface, click the *Git* button (image:images/jupyter-git-sidebar.png[Git button]).

0 commit comments

Comments
 (0)