Skip to content

Commit 84805cc

Browse files
committed
rhai-1448 copy edits and image updates
1 parent 5cd1403 commit 84805cc

21 files changed

Lines changed: 143 additions & 111 deletions
-84.6 KB
Binary file not shown.
87.1 KB
Loading
-64.9 KB
Loading

assets/usecase/knowledge-tuning/Knowledge Genertaion.png renamed to assets/usecase/knowledge-tuning/Knowledge Generation.png

File renamed without changes.

assets/usecase/knowledge-tuning/Knowledge Tuning Workflow.excalidraw

Lines changed: 96 additions & 58 deletions
Large diffs are not rendered by default.
-10.5 KB
Loading

examples/knowledge-tuning/00_Setup/.env.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# The environment variables required are listed below on a step-by-step basis.
33
# Please set them in your own .env file before running the notebooks.
44

5-
# Data Preprocessing Configuration
5+
# Data Processing Configuration
66

77

88
# Knowledge Tuning Configuration

examples/knowledge-tuning/00_Setup/00_Setup_README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,23 +20,23 @@ To use the Knowledge Tuning example, follow these steps to set up your working e
2020
3. [Create a workbench](#create-a-workbench)
2121
4. [Clone the example Git repository](#clone-the-example-git-repository)
2222

23-
For this example, you create an OpenShift project and a workbench. From the workench, you launch an JupyterLab integrated development environment. In JupyterLab, you run the provided notebooks that guide you through the example data processing, knowledge generation and mixing, model training, and evaluation workflow.
23+
For this example, you create an OpenShift project and a workbench. From the workench, you launch a JupyterLab integrated development environment. In JupyterLab, you run the provided notebooks that guide you through the Knowledge Tuning example end-to-end workflow.
2424

2525
## Configure resources on the OpenShift cluster
2626

2727
The notebooks provided in the Knowledge Tuning example require the following resources:
2828

29-
- **GPUs:** GPUs are optional for the preprocessing and mixing steps. For the model training step, fine-tuning large models requires at least one NVIDIA A100/40GB or similar. Training smaller student models requires 8–16 GB GPU.
29+
- **GPUs:** GPUs are optional for the data processing and mixing steps. For the model training step, fine-tuning large models requires at least one NVIDIA A100/40GB or similar. Training smaller student models requires 8–16 GB GPU.
3030

3131
- **Persistent Volumes:** Attach a persistent volume with at least 200 GB.
3232

33-
To run all of the notebooks in the Knowledge Training example, you must ensure that the following resources are configured on the OpenShift cluster:
33+
To run all of the notebooks in the Knowledge Tuning example, you must ensure that the following resources are configured on the OpenShift cluster:
3434

3535
- Your Red Hat OpenShift cluster administrator must configure the following resources:
3636

3737
- A persistent volume with a storage capacity of 200 GB or greater.
3838

39-
- Installed and enabled a NVIDIA GPU as described in [Enabling accelerators]https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/3.0/html/working_with_accelerators/enabling-accelerators_accelerators.
39+
- An NVIDIA GPU that is installed and enabled, as described in [Enabling accelerators](https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/3.0/html/working_with_accelerators/enabling-accelerators_accelerators).
4040

4141
- An OpenShift AI administrator must create a hardware profile that allocates the following resources, as described in [Creating a hardware profile](https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/3.0/html/working_with_accelerators/working-with-hardware-profiles_accelerators#creating-a-hardware-profile_accelerators).
4242

@@ -74,7 +74,7 @@ You can see your project's initial state.
7474

7575
## Create a workbench
7676

77-
A workbench is an instance of your development and experimentation environment. When you create a workbench, you select a workbench image that has the tools, libraries, and an integrated development environment, such as JupyetrLab, that you need for developing AI models.
77+
A workbench is an instance of your development and experimentation environment. When you create a workbench, you select a workbench image that has the tools, libraries, and an integrated development environment, such as JupyterLab, that you need for developing AI models.
7878

7979
The JupyterLab environment is a web-based environment, but everything you do inside it happens on Red Hat OpenShift AI and is powered by the OpenShift cluster. This means that, without having to install and maintain anything on your own computer, and without using valuable local resources such as CPU, GPU and RAM, you can conduct your work in this powerful and stable managed environment.
8080

@@ -90,9 +90,9 @@ The JupyterLab environment is a web-based environment, but everything you do ins
9090

9191
3. Fill out the name and description.
9292

93-
Red Hat OpenShift AI provides several supported workbench images. In the **Workbench image** section, you can select one of the default images or a custom image that an administrator has set up for you. The **Jupyter | Minimal | CUDA | Python 3.12** has the libraries needed for this example.
93+
Red Hat OpenShift AI provides several supported workbench images.
9494

95-
4. Select the latest **Jupyter | Minimal | CUDA | Python 3.12** image.
95+
4. For this example, select the **Jupyter | Minimal | CUDA | Python 3.12** image.
9696

9797
5. Select the latest version: **2025.2**.
9898

@@ -138,7 +138,7 @@ The files for each step in the Knowledge Tuning example end-to-end workflow are
138138

139139
In the file browser, view the notebooks that you cloned from Git.
140140

141-
Congratulations! Your workbench is configured and ready for the knowledge training example. The notebooks and supporting README files provide details about each step in the knowledge training workflow.
141+
Congratulations! Your workbench is configured and ready for the Knowledge Tuning example. The notebooks and supporting README files provide details about each step in the Knowledge Tuning workflow.
142142

143143
## Next step
144144

examples/knowledge-tuning/01_Base_Model_Evaluation/01_Base_Model_Evaluation_README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
## Evaluate the base model
1616

17-
Before you train a base model, evaluate it's preliminary performance. Later, after you train the model with your data, you can objectively compare how effective the knowledge tuning tasks are for customizing the model.
17+
In the Teacher-Student model paradigm, the student model is also known as the base model. Before you train a base model, evaluate it's preliminary performance. Later, after you train the model with your data, you can objectively compare how effective the knowledge tuning tasks are for customizing the model.
1818

1919
### Prerequisites
2020

examples/knowledge-tuning/01_Base_Model_Evaluation/Base_Model_Evaluation.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"\n",
1010
"\n",
1111
"## Overview\n",
12-
"Evaluation is a crucial step in the knowldedge tuning workflow. It allows you to measure the performance and generalization ability of your model. In this notebook, you systematically evaluate the base model by using appropriate metrics and validation datasets before you fine tune the model on the example Bank of Montreal (BMO) data.\n",
12+
"Evaluation is a crucial step in the Knowldedge Tuning workflow. It allows you to measure the performance and generalization ability of your model. In this notebook, you systematically evaluate the base model by using appropriate metrics and validation datasets before you fine tune the model on the example Bank of Montreal (BMO) data.\n",
1313
"\n",
1414
"Throughout this notebook, you use visualizations and quantitative metrics to analyze performance of the base model."
1515
]

0 commit comments

Comments
 (0)