From 6e4097a51c68860dc76f93b53965c620387cbfb6 Mon Sep 17 00:00:00 2001 From: Melissa Flinn <31925014+MelissaFlinn@users.noreply.github.com> Date: Thu, 12 Sep 2024 18:09:50 -0400 Subject: [PATCH] doc-edit adjust image sizes (#44) * doc-edit adjust image sizes * doc-edits adjust git branch section --- 1_experiment_train.ipynb | 14 +++++++++++++ .../automating-workflows-with-pipelines.adoc | 8 ++++---- .../ROOT/pages/creating-a-workbench.adoc | 4 ++-- .../creating-data-connections-to-storage.adoc | 6 +++--- .../deploying-a-model-multi-model-server.adoc | 4 ++-- ...deploying-a-model-single-model-server.adoc | 2 +- .../enabling-data-science-pipelines.adoc | 4 ++-- .../pages/importing-files-into-jupyter.adoc | 20 +++++++++---------- .../pages/navigating-to-the-dashboard.adoc | 2 +- .../pages/running-code-in-a-notebook.adoc | 4 ++-- .../setting-up-your-data-science-project.adoc | 2 +- 11 files changed, 42 insertions(+), 28 deletions(-) diff --git a/1_experiment_train.ipynb b/1_experiment_train.ipynb index d604652..785ce5d 100644 --- a/1_experiment_train.ipynb +++ b/1_experiment_train.ipynb @@ -56,6 +56,13 @@ "from pathlib import Path" ] }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "The output might show TensorFlow messages, such as a \"Could not find TensorRT\" warning. You can ignore these messages.\n" + ] + }, { "cell_type": "markdown", "metadata": {}, @@ -197,6 +204,13 @@ "onnx.save(model_proto, \"models/fraud/1/model.onnx\")" ] }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "The output might include TensorFlow messages related to GPUs. You can ignore these messages." + ] + }, { "cell_type": "markdown", "metadata": {}, diff --git a/workshop/docs/modules/ROOT/pages/automating-workflows-with-pipelines.adoc b/workshop/docs/modules/ROOT/pages/automating-workflows-with-pipelines.adoc index 2a0c592..488ffa6 100644 --- a/workshop/docs/modules/ROOT/pages/automating-workflows-with-pipelines.adoc +++ b/workshop/docs/modules/ROOT/pages/automating-workflows-with-pipelines.adoc @@ -17,7 +17,7 @@ image::pipelines/wb-pipeline-launcher.png[Pipeline buttons] . Click *Pipeline Editor*. + -image::pipelines/wb-pipeline-editor-button.png[Pipeline Editor button, 100] +image::pipelines/wb-pipeline-editor-button.png[Pipeline Editor button, 75] + You've created a blank pipeline. @@ -25,7 +25,7 @@ You've created a blank pipeline. .. In the pipeline editor, click *Open Panel*. + -image::pipelines/wb-pipeline-panel-button-loc.png[Open Panel] +image::pipelines/wb-pipeline-panel-button-loc.png[Open Panel,400] .. Select the *Pipeline Properties* tab. + @@ -59,7 +59,7 @@ NOTE: If you don't set this file dependency, the file is not included in the nod . Click the `1_experiment_train.ipynb` node. + -image::pipelines/wb-pipeline-node-1.png[Select Node 1, 200] +image::pipelines/wb-pipeline-node-1.png[Select Node 1, 150] . In the *Properties* panel, click the *Node Properties* tab. @@ -144,7 +144,7 @@ image::pipelines/wb-pipeline-add-kube-secret.png[Add Kubernetes Secret] ** *Secret Name*: `aws-connection-my-storage` ** *Secret Key*: `AWS_ACCESS_KEY_ID` + -image::pipelines/wb-pipeline-kube-secret-form.png[Secret Form, 400] +image::pipelines/wb-pipeline-kube-secret-form.png[Secret Form, 300] . Repeat Step 2 for each of the following Kubernetes secrets: diff --git a/workshop/docs/modules/ROOT/pages/creating-a-workbench.adoc b/workshop/docs/modules/ROOT/pages/creating-a-workbench.adoc index 2dc362a..a50a534 100644 --- a/workshop/docs/modules/ROOT/pages/creating-a-workbench.adoc +++ b/workshop/docs/modules/ROOT/pages/creating-a-workbench.adoc @@ -42,7 +42,7 @@ image::workbenches/create-workbench-form-data-connection.png[Data connection, 60 . Click the *Create workbench* button. + -image::workbenches/create-workbench-form-button.png[Create workbench button] +image::workbenches/create-workbench-form-button.png[Create workbench button, 150] .Verification @@ -52,7 +52,7 @@ image::workbenches/ds-project-workbench-list.png[Workbench list] NOTE: If you made a mistake, you can edit the workbench to make changes. -image::workbenches/ds-project-workbench-list-edit.png[Workbench list edit, 300] +image::workbenches/ds-project-workbench-list-edit.png[Workbench list edit, 250] .Next step diff --git a/workshop/docs/modules/ROOT/pages/creating-data-connections-to-storage.adoc b/workshop/docs/modules/ROOT/pages/creating-data-connections-to-storage.adoc index 6471132..11dccf4 100644 --- a/workshop/docs/modules/ROOT/pages/creating-data-connections-to-storage.adoc +++ b/workshop/docs/modules/ROOT/pages/creating-data-connections-to-storage.adoc @@ -31,7 +31,7 @@ image::projects/ds-project-add-dc.png[Add data connection] + NOTE: Skip the *Connected workbench* item. You add data connections to a workbench in a later section. + -image::projects/ds-project-my-storage-form.png[Add my storage form] +image::projects/ds-project-my-storage-form.png[Add my storage form, 400] .. Click *Add data connection*. @@ -45,7 +45,7 @@ NOTE: If you do not intend to complete the pipelines section of the {deliverable + NOTE: Skip the *Connected workbench* item. You add data connections to a workbench in a later section. + -image::projects/ds-project-pipeline-artifacts-form.png[Add pipeline artifacts form] +image::projects/ds-project-pipeline-artifacts-form.png[Add pipeline artifacts form, 400] .. Click *Add data connection*. @@ -54,7 +54,7 @@ image::projects/ds-project-pipeline-artifacts-form.png[Add pipeline artifacts fo In the *Data connections* tab for the project, check to see that your data connections are listed. -image::projects/ds-project-dc-list.png[List of project data connections] +image::projects/ds-project-dc-list.png[List of project data connections, 400] .Next steps diff --git a/workshop/docs/modules/ROOT/pages/deploying-a-model-multi-model-server.adoc b/workshop/docs/modules/ROOT/pages/deploying-a-model-multi-model-server.adoc index 173e5b1..e37d00f 100644 --- a/workshop/docs/modules/ROOT/pages/deploying-a-model-multi-model-server.adoc +++ b/workshop/docs/modules/ROOT/pages/deploying-a-model-multi-model-server.adoc @@ -22,7 +22,7 @@ NOTE: Depending on how model serving has been configured on your cluster, you mi .. For *Serving runtime*, select `OpenVINO Model Server`. .. Leave the other fields with the default settings. + -image::model-serving/create-model-server-form.png[Create model server form] +image::model-serving/create-model-server-form.png[Create model server form, 400] . Click *Add*. @@ -37,7 +37,7 @@ image::model-serving/ds-project-workbench-list-deploy.png[Create model server fo .. Type the path that leads to the version folder that contains your model file: `models/fraud` .. Leave the other fields with the default settings. + -image::model-serving/deploy-model-form-mm.png[Deploy model from for multi-model serving] +image::model-serving/deploy-model-form-mm.png[Deploy model from for multi-model serving, 400] . Click *Deploy*. diff --git a/workshop/docs/modules/ROOT/pages/deploying-a-model-single-model-server.adoc b/workshop/docs/modules/ROOT/pages/deploying-a-model-single-model-server.adoc index 00845ef..1be677e 100644 --- a/workshop/docs/modules/ROOT/pages/deploying-a-model-single-model-server.adoc +++ b/workshop/docs/modules/ROOT/pages/deploying-a-model-single-model-server.adoc @@ -27,7 +27,7 @@ NOTE: Depending on how model serving has been configured on your cluster, you mi .. Type the path that leads to the version folder that contains your model file: `models/fraud` .. Leave the other fields with the default settings. + -image::model-serving/deploy-model-form-sm.png[Deploy model from for single-model serving] +image::model-serving/deploy-model-form-sm.png[Deploy model from for single-model serving, 400] . Click *Deploy*. diff --git a/workshop/docs/modules/ROOT/pages/enabling-data-science-pipelines.adoc b/workshop/docs/modules/ROOT/pages/enabling-data-science-pipelines.adoc index 9da8ce7..e5c2543 100644 --- a/workshop/docs/modules/ROOT/pages/enabling-data-science-pipelines.adoc +++ b/workshop/docs/modules/ROOT/pages/enabling-data-science-pipelines.adoc @@ -38,7 +38,7 @@ You must wait until the pipeline configuration is complete before you continue a + If you have waited more than 5 minutes, and the pipeline server configuration does not complete, you can try to delete the pipeline server and create it again. + -image::projects//ds-project-delete-pipeline-server.png[Delete pipeline server, 300] +image::projects//ds-project-delete-pipeline-server.png[Delete pipeline server, 250] + You can also ask your {productname-short} administrator to verify that self-signed certificates are added to your cluster as described in link:https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/2-latest/html/installing_and_uninstalling_openshift_ai_self-managed/working-with-certificates_certs[Working with certificates]. @@ -47,7 +47,7 @@ You can also ask your {productname-short} administrator to verify that self-sign . Navigate to the *Pipelines* tab for the project. . Next to *Import pipeline*, click the action menu (⋮) and then select *View pipeline server configuration*. + -image::projects/ds-project-pipeline-server-view.png[View pipeline server configuration menu, 300] +image::projects/ds-project-pipeline-server-view.png[View pipeline server configuration menu, 250] + An information box opens and displays the object storage connection information for the pipeline server. diff --git a/workshop/docs/modules/ROOT/pages/importing-files-into-jupyter.adoc b/workshop/docs/modules/ROOT/pages/importing-files-into-jupyter.adoc index ceebbbd..15df949 100644 --- a/workshop/docs/modules/ROOT/pages/importing-files-into-jupyter.adoc +++ b/workshop/docs/modules/ROOT/pages/importing-files-into-jupyter.adoc @@ -23,7 +23,7 @@ This file-browser window shows the files and folders that are saved inside your .. On the toolbar, click the *Git Clone* icon: + -image::workbenches/jupyter-git-icon.png[Git Clone icon, 300] +image::workbenches/jupyter-git-icon.png[Git Clone icon, 200] .. Enter the following {deliverable} Git *https* URL: + @@ -34,28 +34,28 @@ image::workbenches/jupyter-git-icon.png[Git Clone icon, 300] https://github.com/rh-aiservices-bu/fraud-detection.git ---- + -image::workbenches/jupyter-git-modal.png[Git Modal, 300] +image::workbenches/jupyter-git-modal.png[Git Modal, 200] .. Check the *Include submodules* option. .. Check the *Include submodules* option, and then click *Clone*. -.. In the file browser, select the newly-created *fraud-detection* folder. +.. In the file browser, double-click the newly-created *fraud-detection* folder. ++ +image::workbenches/jupyter-file-browser.png[Jupyter file browser, 300] .. In the left navigation bar, click the *Git* icon and then, in the *Filter* field, enter *{git-version}*. + -image::workbenches/jupyter-git-icon-version.png[Git Clone icon, 300] - +image::workbenches/jupyter-git-icon-version.png[Git Clone icon, 200] ++ // the {git-version} attribute value is defined at the top of this file -.. Select *{git-version}* as the current branch. +.. Select *origin/{git-version}*. ++ +The current branch changes to *{git-version}*. .Verification -Double-click the newly-created folder, `fraud-detection`: - -image::workbenches/jupyter-file-browser.png[Jupyter file browser, 300] - In the file browser, you should see the notebooks that you cloned from Git. image::workbenches/jupyter-file-browser-2.png[Jupyter file browser - fraud-detection, 300] diff --git a/workshop/docs/modules/ROOT/pages/navigating-to-the-dashboard.adoc b/workshop/docs/modules/ROOT/pages/navigating-to-the-dashboard.adoc index 0ebe17f..c5913b5 100644 --- a/workshop/docs/modules/ROOT/pages/navigating-to-the-dashboard.adoc +++ b/workshop/docs/modules/ROOT/pages/navigating-to-the-dashboard.adoc @@ -25,7 +25,7 @@ The {productname-short} dashboard shows the *Home* page. NOTE: You can navigate back to the OpenShift console by clicking the application launcher to access the OpenShift console. -image::projects/ds-console-ocp-tile.png[OCP console link] +image::projects/ds-console-ocp-tile.png[OCP console link, 250] For now, stay in the {productname-short} dashboard. diff --git a/workshop/docs/modules/ROOT/pages/running-code-in-a-notebook.adoc b/workshop/docs/modules/ROOT/pages/running-code-in-a-notebook.adoc index a965195..711c3d9 100644 --- a/workshop/docs/modules/ROOT/pages/running-code-in-a-notebook.adoc +++ b/workshop/docs/modules/ROOT/pages/running-code-in-a-notebook.adoc @@ -19,7 +19,7 @@ You can run a code cell from the notebook interface or from the keyboard: * *From the user interface:* Select the cell (by clicking inside the cell or to the left side of the cell) and then click *Run* from the toolbar. + -image::workbenches/run_button.png[Jupyter Run] +image::workbenches/run_button.png[Jupyter Run, 75] * *From the keyboard:* Press `CTRL` + `ENTER` to run a cell or press `SHIFT` + `ENTER` to run the cell and automatically select the next one. @@ -52,7 +52,7 @@ You can do what you want - it's your environment and there is no risk of breakin . Optionally, create a new notebook in which the code cells are run by using a Python 3 kernel: .. Create a new notebook by either selecting *File ->New ->Notebook* or by clicking the Python 3 tile in the Notebook section of the launcher window: + -image::workbenches/new_notebook.png[alt text] +image::workbenches/new_notebook.png[New notebook, 100] You can use different kernels, with different languages or versions, to run in your notebook. diff --git a/workshop/docs/modules/ROOT/pages/setting-up-your-data-science-project.adoc b/workshop/docs/modules/ROOT/pages/setting-up-your-data-science-project.adoc index 34bf38e..adda737 100644 --- a/workshop/docs/modules/ROOT/pages/setting-up-your-data-science-project.adoc +++ b/workshop/docs/modules/ROOT/pages/setting-up-your-data-science-project.adoc @@ -17,7 +17,7 @@ NOTE: If you are using the {org-name} Developer Sandbox, you are provided with a . Enter a display name and description. Based on the display name, a resource name is automatically generated, but you can change if you prefer. + -image::projects/ds-project-new-form.png[New data science project form] +image::projects/ds-project-new-form.png[New data science project form, 300] .Verification