Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions maps/jobs/configure-hardware-accelerators-for-ai-workloads.adoc

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable.

Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
:_mod-docs-content-type: MAP
:context: configure-hardware-accelerators-for-ai-workloads

include::modules/microshift-configure-hardware-accelerators-for-ai-workloads.adoc[leveloffset=+0,chunk="to-content"]

include::modules/microshift-rhoai-workflow.adoc[leveloffset=+1,toc="no"]

include::modules/microshift-rhoai-install.adoc[leveloffset=+1,toc="no"]

include::modules/microshift-inferenceservice-more-options.adoc[leveloffset=+1,toc="no"]
6 changes: 6 additions & 0 deletions maps/jobs/customize-serving-environment.adoc

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable.

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
:_mod-docs-content-type: MAP
:context: customize-serving-environment

include::modules/microshift-customize-serving-environment.adoc[leveloffset=+0,chunk="to-content"]

include::modules/microshift-rhoai-override-kserve-config.adoc[leveloffset=+1,toc="no"]
14 changes: 14 additions & 0 deletions maps/jobs/expose-and-query-ai-models.adoc

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable.

Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
:_mod-docs-content-type: MAP
:context: expose-and-query-ai-models

include::modules/microshift-expose-and-query-ai-models.adoc[leveloffset=+0,chunk="to-content"]

include::modules/microshift-rhoai-create-route.adoc[leveloffset=+1,toc="no"]

include::modules/microshift-rhoai-query-model-con.adoc[leveloffset=+1,toc="no"]

include::modules/microshift-rhoai-query-model.adoc[leveloffset=+1,toc="no"]

include::modules/microshift-rhoai-verify-model-connected.adoc[leveloffset=+1,toc="no"]

include::modules/microshift-rhoai-get-model-ready-inference.adoc[leveloffset=+1,toc="no"]
10 changes: 10 additions & 0 deletions maps/jobs/install-ai-capabilities.adoc

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable.

Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
:_mod-docs-content-type: MAP
:context: install-ai-capabilities

include::modules/microshift-install-ai-capabilities.adoc[leveloffset=+0,chunk="to-content"]

include::modules/microshift-rhoai-con.adoc[leveloffset=+1,toc="no"]

include::modules/microshift-rhoai-workflow.adoc[leveloffset=+1,toc="no"]

include::modules/microshift-rhoai-install.adoc[leveloffset=+1,toc="no"]
8 changes: 8 additions & 0 deletions maps/jobs/monitor-model-performance.adoc

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable.

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
:_mod-docs-content-type: MAP
:context: monitor-model-performance

include::modules/microshift-monitor-model-performance.adoc[leveloffset=+0,chunk="to-content"]

include::modules/microshift-rhoai-get-model-server-metrics.adoc[leveloffset=+1,toc="no"]

include::modules/microshift-rhoai-export-metrics-otel.adoc[leveloffset=+1,toc="no"]
10 changes: 10 additions & 0 deletions maps/jobs/prepare-and-package-ai-models.adoc

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable.

Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
:_mod-docs-content-type: MAP
:context: prepare-and-package-ai-models

include::modules/microshift-prepare-and-package-ai-models.adoc[leveloffset=+0,chunk="to-content"]

include::modules/microshift-rhoai-create-ns.adoc[leveloffset=+1,toc="no"]

include::modules/microshift-rhoai-model-package-oci.adoc[leveloffset=+1,toc="no"]

include::modules/microshift-rhoai-workflow.adoc[leveloffset=+1,toc="no"]
4 changes: 4 additions & 0 deletions maps/jobs/remove-ai-model-serving-components.adoc

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable.

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
:_mod-docs-content-type: MAP
:context: remove-ai-model-serving-components

include::modules/microshift-remove-ai-model-serving-components.adoc[leveloffset=+0,chunk="to-content"]
6 changes: 6 additions & 0 deletions maps/jobs/secure-ai-inference-endpoints.adoc

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable.

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
:_mod-docs-content-type: MAP
:context: secure-ai-inference-endpoints

include::modules/microshift-secure-ai-inference-endpoints.adoc[leveloffset=+0,chunk="to-content"]

include::modules/microshift-rhoai-create-route.adoc[leveloffset=+1,toc="no"]
16 changes: 16 additions & 0 deletions maps/jobs/serve-ai-models.adoc

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable.

Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
:_mod-docs-content-type: MAP
:context: serve-ai-models

include::modules/microshift-serve-ai-models.adoc[leveloffset=+0,chunk="to-content"]

include::modules/microshift-rhoai-serving-ai-models-con.adoc[leveloffset=+1,toc="no"]

include::modules/microshift-rhoai-supported-crds.adoc[leveloffset=+1,toc="no"]

include::modules/microshift-rhoai-supported-mserv-runtimes.adoc[leveloffset=+1,toc="no"]

include::modules/microshift-rhoai-servingruntimes-ex.adoc[leveloffset=+1,toc="no"]

include::modules/microshift-rhoai-inferenceservice-ex.adoc[leveloffset=+1,toc="no"]

include::modules/microshift-rhoai-model-serving-rt-verify.adoc[leveloffset=+1,toc="no"]
4 changes: 4 additions & 0 deletions maps/jobs/update-running-ai-model.adoc

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable.

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
:_mod-docs-content-type: MAP
:context: update-running-ai-model

include::modules/microshift-update-running-ai-model.adoc[leveloffset=+0,chunk="to-content"]
8 changes: 8 additions & 0 deletions maps/jobs/use-alternative-storage-for-ai-models.adoc

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable.

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
:_mod-docs-content-type: MAP
:context: use-alternative-storage-for-ai-models

include::modules/microshift-use-alternative-storage-for-ai-models.adoc[leveloffset=+0,chunk="to-content"]

include::modules/microshift-rhoai-model-package-oci.adoc[leveloffset=+1,toc="no"]

include::modules/microshift-rhoai-workflow.adoc[leveloffset=+1,toc="no"]
25 changes: 25 additions & 0 deletions maps/microshift/ai.adoc

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable.

Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
:_mod-docs-content-type: MAP

= AI

include::jobs/install-ai-capabilities.adoc[leveloffset=+1]

include::jobs/prepare-and-package-ai-models.adoc[leveloffset=+1]

include::jobs/serve-ai-models.adoc[leveloffset=+1]

include::jobs/expose-and-query-ai-models.adoc[leveloffset=+1]

include::jobs/monitor-model-performance.adoc[leveloffset=+1]

include::jobs/customize-serving-environment.adoc[leveloffset=+1]

include::jobs/use-alternative-storage-for-ai-models.adoc[leveloffset=+1]

include::jobs/configure-hardware-accelerators-for-ai-workloads.adoc[leveloffset=+1]

include::jobs/update-running-ai-model.adoc[leveloffset=+1]

include::jobs/secure-ai-inference-endpoints.adoc[leveloffset=+1]

include::jobs/remove-ai-model-serving-components.adoc[leveloffset=+1]
2 changes: 2 additions & 0 deletions maps/microshift/navigation.adoc

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable.

Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ include::configure.adoc[leveloffset=+1]

include::develop.adoc[leveloffset=+1]

include::ai.adoc[leveloffset=+1]

include::upgrade.adoc[leveloffset=+1]

include::plan.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// Module included in the following assemblies:
//
// * maps/jobs/configure-hardware-accelerators-for-ai-workloads.adoc

:_mod-docs-content-type: CONCEPT
[id="microshift-configure-hardware-accelerators-for-ai-workloads_{context}"]
= Configure hardware accelerators for AI workloads

[role="_abstract"]
Configure GPU or NPU accelerators and device plugins so your {microshift-short} node can run inference workloads that require specialized hardware.
10 changes: 10 additions & 0 deletions modules/microshift-customize-serving-environment.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// Module included in the following assemblies:
//
// * maps/jobs/customize-serving-environment.adoc

:_mod-docs-content-type: CONCEPT
[id="microshift-customize-serving-environment_{context}"]
= Adapt AI model serving to your edge constraints

[role="_abstract"]
Override the KServe configuration when the default model-serving environment does not meet your edge deployment constraints.
10 changes: 10 additions & 0 deletions modules/microshift-expose-and-query-ai-models.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// Module included in the following assemblies:
//
// * maps/jobs/expose-and-query-ai-models.adoc

:_mod-docs-content-type: CONCEPT
[id="microshift-expose-and-query-ai-models_{context}"]
= Access your AI model from external applications

[role="_abstract"]
Create a network route and query your running model so you can make external inferences and test model responses.
10 changes: 10 additions & 0 deletions modules/microshift-install-ai-capabilities.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// Module included in the following assemblies:
//
// * maps/jobs/install-ai-capabilities.adoc

:_mod-docs-content-type: CONCEPT
[id="microshift-install-ai-capabilities_{context}"]
= Enable AI model serving on {microshift-short}

[role="_abstract"]
Install the {rhoai-full} RPM on your {microshift-short} node so you can deploy and serve AI models in edge environments.
10 changes: 10 additions & 0 deletions modules/microshift-monitor-model-performance.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// Module included in the following assemblies:
//
// * maps/jobs/monitor-model-performance.adoc

:_mod-docs-content-type: CONCEPT
[id="microshift-monitor-model-performance_{context}"]
= Monitor model performance

[role="_abstract"]
Export and view model-server metrics so you can identify bottlenecks, optimize resource allocation, and ensure efficient infrastructure utilization.
10 changes: 10 additions & 0 deletions modules/microshift-prepare-and-package-ai-models.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// Module included in the following assemblies:
//
// * maps/jobs/prepare-and-package-ai-models.adoc

:_mod-docs-content-type: CONCEPT
[id="microshift-prepare-and-package-ai-models_{context}"]
= Package your AI model for edge deployment

[role="_abstract"]
Create a namespace and package your AI model into an OCI image in ModelCar format so you can securely store and deploy the model to your {microshift-short} node.
15 changes: 15 additions & 0 deletions modules/microshift-remove-ai-model-serving-components.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// Module included in the following assemblies:
//
// * maps/jobs/remove-ai-model-serving-components.adoc

:_mod-docs-content-type: CONCEPT
[id="microshift-remove-ai-model-serving-components_{context}"]
= Remove AI model serving components and free resources

[role="_abstract"]
When you no longer need to serve a model, delete the `InferenceService`, clean up OCI images, and uninstall the `microshift-ai-model-serving` RPM to manage resources on constrained edge nodes.

[NOTE]
====
Documentation for uninstalling AI model serving components is not yet available in the {microshift-short} AI chapter.
====
2 changes: 1 addition & 1 deletion modules/microshift-rhoai-create-ns.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

:_mod-docs-content-type: PROCEDURE
[id="microshift-rhoai-create-namespace_{context}"]
= Creating a namespace for your AI model on {microshift-short}
= Create a namespace for your AI model on {microshift-short}

[role="_abstract"]
Create a namespace for your AI model and all other resources. Namespaces offer resource isolation, resource management, and access control.
Expand Down
2 changes: 1 addition & 1 deletion modules/microshift-rhoai-create-route.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

:_mod-docs-content-type: PROCEDURE
[id="microshift-rhoai-create-route_{context}"]
= Creating a route to use for AI queries in {microshift-short}
= Create a route to use for AI queries in {microshift-short}

[role="_abstract"]
You can create a route so that your AI model can receive queries and give output by using the `oc expose svc` command or creating a definition in a YAML file and apply it.
Expand Down
2 changes: 1 addition & 1 deletion modules/microshift-rhoai-export-metrics-otel.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

:_mod-docs-content-type: PROCEDURE
[id="microshift-rhoai-export-metrics-otel_{context}"]
= Exporting model-server metrics by using Open Telemetry
= Export model-server metrics by using Open Telemetry

[role="_abstract"]
You can export model-server metrics by using Open Telemetry if you installed the `microshift-observability` RPM for {microshift-short}.
Expand Down
2 changes: 1 addition & 1 deletion modules/microshift-rhoai-get-model-ready-inference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

:_mod-docs-content-type: PROCEDURE
[id="microshift-rhoai-get-model-ready-inference_{context}"]
= Getting your AI model ready for inference
= Get your AI model ready for inference

[role="_abstract"]
Before querying your AI model through the API, you can get the model ready to provide answers based on the training data.
Expand Down
2 changes: 1 addition & 1 deletion modules/microshift-rhoai-get-model-server-metrics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

:_mod-docs-content-type: PROCEDURE
[id="microshift-rhoai-get-model-server-metrics_{context}"]
= Getting the model-server metrics
= Get the model-server metrics

[role="_abstract"]
After making a query, you can get the model server's metrics to identify bottlenecks, optimize resource allocation, and ensure efficient infrastructure utilization.
Expand Down
2 changes: 1 addition & 1 deletion modules/microshift-rhoai-inferenceservice-ex.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

:_mod-docs-content-type: PROCEDURE
[id="microshift-rhoai-inferenceservice-ex_{context}"]
= Creating an InferenceService custom resource
= Create an InferenceService custom resource

[role="_abstract"]
You can create an `InferenceService` custom resource (CR) that instructs KServe how to create a deployment for serving your AI model. KServe uses the `ServingRuntime` based on the `modelFormat` value specified in the `InferenceService` CR.
Expand Down
2 changes: 1 addition & 1 deletion modules/microshift-rhoai-model-package-oci.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

:_mod-docs-content-type: PROCEDURE
[id="microshift-rhoai-model-package-oci_{context}"]
= Packaging your AI model into an OCI image
= Package your AI model into an OCI image

[role="_abstract"]
You can package your model into an OCI image and use the ModelCar approach to help you set up offline environments. With the ModelCar approach, your model can be embedded just like any other container image.
Expand Down
2 changes: 1 addition & 1 deletion modules/microshift-rhoai-model-serving-rt-verify.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

:_mod-docs-content-type: PROCEDURE
[id="microshift-rhoai-model-serving-rt-verify_{context}"]
= Verifying that the model-serving runtime is ready
= Verify that the model-serving runtime is ready

[role="_abstract"]
You can use the {oc-first} to verify that your model-serving runtime is ready for use by checking that the downstream generation activities are complete.
Expand Down
2 changes: 1 addition & 1 deletion modules/microshift-rhoai-override-kserve-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

:_mod-docs-content-type: CONCEPT
[id="microshift-rhoai-override-kserve-config_{context}"]
= Overriding KServe configuration
= Override KServe configuration

[role="_abstract"]
You can override KServe settings to customize your model-serving environment.
Expand Down
2 changes: 1 addition & 1 deletion modules/microshift-rhoai-query-model.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

:_mod-docs-content-type: PROCEDURE
[id="microshift-rhoai-query-model_{context}"]
= Querying your AI model
= Query your AI model

[role="_abstract"]
You can make an inference request against the AI model server that is using the `ovms-resnet50` model.
Expand Down
2 changes: 1 addition & 1 deletion modules/microshift-rhoai-servingruntimes-ex.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

:_mod-docs-content-type: PROCEDURE
[id="microshift-rhoai-servingruntimes-ex_{context}"]
= Creating a ServingRuntime CR for use in {microshift-short}
= Create a ServingRuntime CR for use in {microshift-short}

[role="_abstract"]
You can create a `ServingRuntime` custom resource (CR) based on installed manifests and release information.
Expand Down
2 changes: 1 addition & 1 deletion modules/microshift-rhoai-verify-model-connected.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

:_mod-docs-content-type: PROCEDURE
[id="microshift-rhoai-verify-model-connected_{context}"]
= Verifying that your AI model is accessible
= Verify that your AI model is accessible

[role="_abstract"]
Before querying the model through the API, you can verify that the model is accessible and ready to provide answers based on the connected data.
Expand Down
10 changes: 10 additions & 0 deletions modules/microshift-secure-ai-inference-endpoints.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// Module included in the following assemblies:
//
// * maps/jobs/secure-ai-inference-endpoints.adoc

:_mod-docs-content-type: CONCEPT
[id="microshift-secure-ai-inference-endpoints_{context}"]
= Secure your AI inference endpoints

[role="_abstract"]
Add TLS encryption and authentication to inference routes so you can protect model access and meet security requirements.
10 changes: 10 additions & 0 deletions modules/microshift-serve-ai-models.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// Module included in the following assemblies:
//
// * maps/jobs/serve-ai-models.adoc

:_mod-docs-content-type: CONCEPT
[id="microshift-serve-ai-models_{context}"]
= Serve AI models on {microshift-short}

[role="_abstract"]
Configure a model-serving runtime and create an `InferenceService` custom resource so you can serve your AI model on {microshift-short}.
15 changes: 15 additions & 0 deletions modules/microshift-update-running-ai-model.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// Module included in the following assemblies:
//
// * maps/jobs/update-running-ai-model.adoc

:_mod-docs-content-type: CONCEPT
[id="microshift-update-running-ai-model_{context}"]
= Update a running AI model to a newer version

[role="_abstract"]
When a newer version of your AI model is available, update the served model without downtime so you can deliver improved inference results.

[NOTE]
====
Documentation for updating a running model is not yet available in the {microshift-short} AI chapter.
====
10 changes: 10 additions & 0 deletions modules/microshift-use-alternative-storage-for-ai-models.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// Module included in the following assemblies:
//
// * maps/jobs/use-alternative-storage-for-ai-models.adoc

:_mod-docs-content-type: CONCEPT
[id="microshift-use-alternative-storage-for-ai-models_{context}"]
= Use alternative storage for your AI models

[role="_abstract"]
When you already have S3-compatible storage or a persistent volume claim, you can point your `InferenceService` to that storage instead of packaging a ModelCar OCI image. Only the ModelCar approach is tested and supported for {microshift-short}.