[pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

CodeGen/openshift-rhoai/manifests/README.md

@@ -2,19 +2,21 @@
 
 ## Prerequisites
 
-1. **Red Hat OpenShift Cluster** with dynamic *StorageClass* to provision *PersistentVolumes* e.g. **OpenShift Data Foundation**) and installed Operators: **Red Hat - Authorino (Technical Preview)**, **Red Hat OpenShift Service Mesh**, **Red Hat OpenShift Serverless** and **Red Hat Openshift AI**.
+1. **Red Hat OpenShift Cluster** with dynamic _StorageClass_ to provision _PersistentVolumes_ e.g. **OpenShift Data Foundation**) and installed Operators: **Red Hat - Authorino (Technical Preview)**, **Red Hat OpenShift Service Mesh**, **Red Hat OpenShift Serverless** and **Red Hat Openshift AI**.
 2. Exposed image registry to push there docker images (https://docs.openshift.com/container-platform/4.16/registry/securing-exposing-registry.html).
 3. Access to S3-compatible object storage bucket (e.g. **OpenShift Data Foundation**, **AWS S3**) and values of access and secret access keys and S3 endpoint (https://docs.redhat.com/en/documentation/red_hat_openshift_data_foundation/4.16/html/managing_hybrid_and_multicloud_resources/accessing-the-multicloud-object-gateway-with-your-applications_rhodf#accessing-the-multicloud-object-gateway-with-your-applications_rhodf)\
-4. Account on https://huggingface.co/, access to model _ise-uiuc/Magicoder-S-DS-6.7B_ (for Xeon) or _meta-llama/CodeLlama-7b-hf_ (for Gaudi)  and token with _Read permissions_. Update the access token in your repository using following commands.
+4. Account on https://huggingface.co/, access to model _ise-uiuc/Magicoder-S-DS-6.7B_ (for Xeon) or _meta-llama/CodeLlama-7b-hf_ (for Gaudi) and token with _Read permissions_. Update the access token in your repository using following commands.
 
 On Xeon:
+
 ```
 cd GenAIExamples/CodeGen/openshift-rhoai/manifests/xeon
 export HFTOKEN="YourOwnToken"
 sed -i "s/insert-your-huggingface-token-here/${HFTOKEN}/g" codegen.yaml servingruntime-magicoder.yaml
 ```
 
 On Gaudi:
+
 ```
 cd GenAIExamples/CodeGen/openshift-rhoai/manifests/gaudi
 export HFTOKEN="YourOwnToken"
@@ -26,35 +28,42 @@ sed -i "s/insert-your-huggingface-token-here/${HFTOKEN}/g" codegen.yaml servingr
 1. Log in to OpenShift CLI and run following commands to create new serving runtime.
 
 On Xeon:
+
 ```
 cd GenAIExamples/CodeGen/openshift-rhoai/manifests/xeon
 oc apply -f servingruntime-magicoder.yaml
 ```
 
 On Gaudi:
+
 ```
 cd GenAIExamples/CodeGen/openshift-rhoai/manifests/gaudi
 oc apply -f servingruntime-codellama.yaml
 ```
 
-Verify if template has been created with ```oc get template -n redhat-ods-applications``` command.
+Verify if template has been created with `oc get template -n redhat-ods-applications` command.
 
 2. Find the route for **Red Hat OpenShift AI** dashboard with below command and open it in the browser:
+
 ```
 oc get routes -A | grep rhods-dashboard
 ```
-3. Go to **Data Science Project** and clik **Create data science project**. Fill the **Name** and click **Create**.
-4. Go to **Workbenches** tab and clik **Create workbench**. Fill the **Name**, under **Notebook image** choose *Standard Data Science*, under **Cluster storage** choose *Create new persistent storage* and change **Persistent storage size** to 40 GB. Click **Create workbench**.
+
+3. Go to **Data Science Project** and click **Create data science project**. Fill the **Name** and click **Create**.
+4. Go to **Workbenches** tab and click **Create workbench**. Fill the **Name**, under **Notebook image** choose _Standard Data Science_, under **Cluster storage** choose _Create new persistent storage_ and change **Persistent storage size** to 40 GB. Click **Create workbench**.
 5. Open newly created Jupiter notebook and run following commands to download the model and upload it on s3:
+
 ```
 %env S3_ENDPOINT=<S3_RGW_ROUTE>
 %env S3_ACCESS_KEY=<AWS_ACCESS_KEY_ID>
 %env S3_SECRET_KEY=<AWS_SECRET_ACCESS_KEY>
 %env HF_TOKEN=<PASTE_HUGGINGFACE_TOKEN>
 ```
+
 ```
 !pip install huggingface-hub
 ```
+
 ```
 import os
 import boto3
@@ -75,41 +84,52 @@ s3_resource = session.resource('s3',
                                aws_secret_access_key=s3_secretkey)
 bucket = s3_resource.Bucket(bucket_name)
 ```
-For Xeon download *ise-uiuc/Magicoder-S-DS-6.7B*:
+
+For Xeon download _ise-uiuc/Magicoder-S-DS-6.7B_:
+
 ```
 snapshot_download("ise-uiuc/Magicoder-S-DS-6.7B", cache_dir=f'./models', token=hf_token)
 ```
-For Gaudi download *meta-llama/CodeLlama-7b-hf*:
+
+For Gaudi download _meta-llama/CodeLlama-7b-hf_:
+
 ```
 snapshot_download("meta-llama/CodeLlama-7b-hf", cache_dir=f'./models', token=hf_token)
 ```
+
 Upload the downloaded model to S3:
+
 ```
 files = (file for file in glob.glob(f'{path}/**/*', recursive=True) if os.path.isfile(file) and "snapshots" in file)
 for filename in files:
     s3_name = filename.replace(path, '')
     print(f'Uploading: {filename} to {path}{s3_name}')
     bucket.upload_file(filename, f'{path}{s3_name}')
 ```
-6. Go to your project in **Red Hat OpenShift AI** dashboard, then "Models" tab and click **Deploy model** under *Single-model serving platform*. Fill the **Name**, choose newly created **Serving runtime**: *Text Generation Inference Magicoder-S-DS-6.7B on CPU* (for Xeon) or *Text Generation Inference CodeLlama-7b-hf on Gaudi* (for Gaudi), **Model framework**: *llm* and change **Model server size** to *Custom*: 16 CPUs and 64 Gi memory. For deployment with Gaudi select proper **Accelerator**. Click the checkbox to create external route in **Model route** section and uncheck the token authentication. Under **Model location** choose *New data connection* and fill all required fields for s3 access, **Bucket** *first.bucket* and **Path**: *models*. Click **Deploy**. It takes about 10 minutes to get *Loaded* status.\
-If it's not going to *Loaded* status and revision changed status to "ProgressDeadlineExceeded" (``oc get revision``), scale model deployment to 0 and than to 1 with command ``oc scale deployment.apps/<model_deployment_name> --replicas=1`` and wait about 10 minutes for deployment.
+
+6. Go to your project in **Red Hat OpenShift AI** dashboard, then "Models" tab and click **Deploy model** under _Single-model serving platform_. Fill the **Name**, choose newly created **Serving runtime**: _Text Generation Inference Magicoder-S-DS-6.7B on CPU_ (for Xeon) or _Text Generation Inference CodeLlama-7b-hf on Gaudi_ (for Gaudi), **Model framework**: _llm_ and change **Model server size** to _Custom_: 16 CPUs and 64 Gi memory. For deployment with Gaudi select proper **Accelerator**. Click the checkbox to create external route in **Model route** section and uncheck the token authentication. Under **Model location** choose _New data connection_ and fill all required fields for s3 access, **Bucket** _first.bucket_ and **Path**: _models_. Click **Deploy**. It takes about 10 minutes to get _Loaded_ status.\
+   If it's not going to _Loaded_ status and revision changed status to "ProgressDeadlineExceeded" (`oc get revision`), scale model deployment to 0 and than to 1 with command `oc scale deployment.apps/<model_deployment_name> --replicas=1` and wait about 10 minutes for deployment.
 
 ## Deploy CodeGen
 
 1. Login to OpenShift CLI, go to your project and find the URL of TGI_LLM_ENDPOINT:
+
 ```
 oc get service.serving.knative.dev
 ```
+
 Update the TGI_LLM_ENDPOINT in your repository.
 
 On Xeon:
+
 ```
 cd GenAIExamples/CodeGen/openshift-rhoai/manifests/xeon
 export TGI_LLM_ENDPOINT="YourURL"
 sed -i "s#insert-your-tgi-url-here#${TGI_LLM_ENDPOINT}#g" codegen.yaml
 ```
 
 On Gaudi:
+
 ```
 cd GenAIExamples/CodeGen/openshift-rhoai/manifests/gaudi
 export TGI_LLM_ENDPOINT="YourURL"
@@ -119,22 +139,28 @@ sed -i "s#insert-your-tgi-url-here#${TGI_LLM_ENDPOINT}#g" codegen.yaml
 2. Build docker images locally
 
 - LLM Docker Image:
+
 ```
 git clone https://github.com/opea-project/GenAIComps.git
 cd GenAIComps
 docker build -t opea/llm-tgi:latest --build-arg https_proxy=$https_proxy --build-arg http_proxy=$http_proxy -f comps/llms/text-generation/tgi/Dockerfile .
 ```
+
 - MegaService Docker Image:
+
 ```
 git clone https://github.com/opea-project/GenAIExamples
 cd GenAIExamples/CodeGen
 docker build -t opea/codegen:latest --build-arg https_proxy=$https_proxy --build-arg http_proxy=$http_proxy -f Dockerfile .
 ```
+
 - UI Docker Image:
+
 ```
 cd GenAIExamples/CodeGen/ui
 docker build -t opea/codegen-ui:latest --build-arg https_proxy=$https_proxy --build-arg http_proxy=$http_proxy -f ./docker/Dockerfile .
 ```
+
 To verify run the command: `docker images`.
 
 3. Login to docker, tag the images and push it to image registry with following commands:
@@ -144,11 +170,13 @@ docker login -u <user> -p $(oc whoami -t) <openshift-image-registry_route>
 docker tag <image_id> <openshift-image-registry_route>/<namespace>/<image_name>:<tag>
 docker push <openshift-image-registry_route>/<namespace>/<image_name>:<tag>
 ```
+
 To verify run the command: `oc get istag`.
 
-4. Use the *IMAGE REFERENCE* from previous step to update images names in manifest files.
+4. Use the _IMAGE REFERENCE_ from previous step to update images names in manifest files.
 
 On Xeon:
+
 ```
 cd GenAIExamples/CodeGen/openshift-rhoai/manifests/xeon
 export IMAGE_LLM_TGI="YourImage"
@@ -160,6 +188,7 @@ sed -i "s#insert-your-image-codegen-ui#${IMAGE_CODEGEN_UI}#g" ui-server.yaml
 ```
 
 On Gaudi:
+
 ```
 cd GenAIExamples/CodeGen/openshift-rhoai/manifests/gaudi
 export IMAGE_LLM_TGI="YourImage"
@@ -170,33 +199,38 @@ sed -i "s#insert-your-image-codegen#${IMAGE_CODEGEN}#g" codegen.yaml
 sed -i "s#insert-your-image-codegen-ui#${IMAGE_CODEGEN_UI}#g" ui-server.yaml
 ```
 
-5. Create *rhoai-ca-bundle* secret:
+5. Create _rhoai-ca-bundle_ secret:
+
 ```
 oc create secret generic rhoai-ca-bundle --from-literal=tls.crt="$(oc extract secret/knative-serving-cert -n istio-system --to=- --keys=tls.crt)"
 ```
 
 6. Deploy CodeGen with command:
+
 ```
 oc apply -f codegen.yaml
 ```
 
-7. Check the *codegen* route with command `oc get routes` and update the route in *ui-server.yaml* file: 
+7. Check the _codegen_ route with command `oc get routes` and update the route in _ui-server.yaml_ file:
 
 On Xeon:
+
 ```
 cd GenAIExamples/CodeGen/openshift-rhoai/manifests/xeon
 export CODEGEN_ROUTE="YourCodegenRoute"
 sed -i "s/insert-your-codegen-route/${CODEGEN_ROUTE}/g" ui-server.yaml
 ```
 
 On Gaudi:
+
 ```
 cd GenAIExamples/CodeGen/openshift-rhoai/manifests/gaudi
 export CODEGEN_ROUTE="YourCodegenRoute"
 sed -i "s/insert-your-codegen-route/${CODEGEN_ROUTE}/g" ui-server.yaml
 ```
 
 8. Deploy UI with command:
+
 ```
 oc apply -f ui-server.yaml
 ```
@@ -214,4 +248,4 @@ curl http://${CODEGEN_ROUTE}/v1/codegen -H "Content-Type: application/json" -d '
 
 ## Launch the UI
 
-To access the frontend, find the route for *ui-server* with command `oc get routes` and open it in the browser.
+To access the frontend, find the route for _ui-server_ with command `oc get routes` and open it in the browser.

CodeGen/openshift-rhoai/manifests/gaudi/servingruntime-codellama.yaml

@@ -1,3 +1,6 @@
+# Copyright (C) 2024 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+
 ---
 apiVersion: template.openshift.io/v1
 kind: Template

CodeGen/openshift-rhoai/manifests/gaudi/ui-server.yaml

@@ -1,3 +1,6 @@
+# Copyright (C) 2024 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+
 apiVersion: apps/v1
 kind: Deployment
 metadata:

CodeGen/openshift-rhoai/manifests/xeon/servingruntime-magicoder.yaml

@@ -1,3 +1,6 @@
+# Copyright (C) 2024 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+
 ---
 apiVersion: template.openshift.io/v1
 kind: Template

CodeGen/openshift-rhoai/manifests/xeon/ui-server.yaml

@@ -1,3 +1,6 @@
+# Copyright (C) 2024 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+
 apiVersion: apps/v1
 kind: Deployment
 metadata:

CodeGen/openshift/manifests/README.md

@@ -2,18 +2,20 @@
 
 ## Prerequisites
 
-1. **Red Hat OpenShift Cluster** with dynamic *StorageClass* to provision *PersistentVolumes* e.g. **OpenShift Data Foundation**)
+1. **Red Hat OpenShift Cluster** with dynamic _StorageClass_ to provision _PersistentVolumes_ e.g. **OpenShift Data Foundation**)
 2. Exposed image registry to push there docker images (https://docs.openshift.com/container-platform/4.16/registry/securing-exposing-registry.html).
-3. Account on https://huggingface.co/, access to model *ise-uiuc/Magicoder-S-DS-6.7B* (for Xeon) or *meta-llama/CodeLlama-7b-hf* (for Gaugi) and token with _Read permissions_. Update the access token in your repository using following commands.
+3. Account on https://huggingface.co/, access to model _ise-uiuc/Magicoder-S-DS-6.7B_ (for Xeon) or _meta-llama/CodeLlama-7b-hf_ (for Gaugi) and token with _Read permissions_. Update the access token in your repository using following commands.
 
 On Xeon:
+
 ```
 cd GenAIExamples/CodeGen/openshift/manifests/xeon
 export HFTOKEN="YourOwnToken"
 sed -i "s/insert-your-huggingface-token-here/${HFTOKEN}/g" codegen.yaml
 ```
 
 On Gaudi:
+
 ```
 cd GenAIExamples/CodeGen/openshift/manifests/gaudi
 export HFTOKEN="YourOwnToken"
@@ -25,22 +27,28 @@ sed -i "s/insert-your-huggingface-token-here/${HFTOKEN}/g" codegen.yaml
 1. Build docker images locally
 
 - LLM Docker Image:
+
 ```
 git clone https://github.com/opea-project/GenAIComps.git
 cd GenAIComps
 docker build -t opea/llm-tgi:latest --build-arg https_proxy=$https_proxy --build-arg http_proxy=$http_proxy -f comps/llms/text-generation/tgi/Dockerfile .
 ```
+
 - MegaService Docker Image:
+
 ```
 git clone https://github.com/opea-project/GenAIExamples
 cd GenAIExamples/CodeGen
 docker build -t opea/codegen:latest --build-arg https_proxy=$https_proxy --build-arg http_proxy=$http_proxy -f Dockerfile .
 ```
+
 - UI Docker Image:
+
 ```
 cd GenAIExamples/CodeGen/ui
 docker build -t opea/codegen-ui:latest --build-arg https_proxy=$https_proxy --build-arg http_proxy=$http_proxy -f ./docker/Dockerfile .
 ```
+
 To verify run the command: `docker images`.
 
 2. Login to docker, tag the images and push it to image registry with following commands:
@@ -50,11 +58,13 @@ docker login -u <user> -p $(oc whoami -t) <openshift-image-registry_route>
 docker tag <image_id> <openshift-image-registry_route>/<namespace>/<image_name>:<tag>
 docker push <openshift-image-registry_route>/<namespace>/<image_name>:<tag>
 ```
+
 To verify run the command: `oc get istag`.
 
 3. Update images names in manifest files.
 
 On Xeon:
+
 ```
 cd GenAIExamples/CodeGen/openshift/manifests/xeon
 export IMAGE_LLM_TGI="YourImage"
@@ -66,6 +76,7 @@ sed -i "s#insert-your-image-codegen-ui#${IMAGE_CODEGEN_UI}#g" ui-server.yaml
 ```
 
 On Gaudi:
+
 ```
 cd GenAIExamples/CodeGen/openshift/manifests/gaudi
 export IMAGE_LLM_TGI="YourImage"
@@ -77,27 +88,31 @@ sed -i "s#insert-your-image-codegen-ui#${IMAGE_CODEGEN_UI}#g" ui-server.yaml
 ```
 
 4. Deploy CodeGen with command:
+
 ```
 oc apply -f codegen.yaml
 ```
 
-5. Check the *codegen* route with command `oc get routes` and update the route in *ui-server.yaml* file.
+5. Check the _codegen_ route with command `oc get routes` and update the route in _ui-server.yaml_ file.
 
 On Xeon:
+
 ```
 cd GenAIExamples/CodeGen/openshift/manifests/xeon
 export CODEGEN_ROUTE="YourCodegenRoute"
 sed -i "s/insert-your-codegen-route/${CODEGEN_ROUTE}/g" ui-server.yaml
 ```
 
 On Gaudi:
+
 ```
 cd GenAIExamples/CodeGen/openshift/manifests/gaudi
 export CODEGEN_ROUTE="YourCodegenRoute"
 sed -i "s/insert-your-codegen-route/${CODEGEN_ROUTE}/g" ui-server.yaml
 ```
 
 6. Deploy UI with command:
+
 ```
 oc apply -f ui-server.yaml
 ```
@@ -115,4 +130,4 @@ curl http://${CODEGEN_ROUTE}/v1/codegen -H "Content-Type: application/json" -d '
 
 ## Launch the UI
 
-To access the frontend, find the route for *ui-server* with command `oc get routes` and open it in the browser.
+To access the frontend, find the route for _ui-server_ with command `oc get routes` and open it in the browser.

CodeGen/openshift/manifests/gaudi/codegen.yaml

@@ -175,8 +175,8 @@ spec:
           startupProbe:
             exec:
               command:
-                - python 
-                - -c 
+                - python
+                - -c
                 - 'import requests; req = requests.get("http://codegen-tgi:8080/info"); print(req)'
             initialDelaySeconds: 5
             periodSeconds: 5

CodeGen/openshift/manifests/gaudi/ui-server.yaml

@@ -1,3 +1,6 @@
+# Copyright (C) 2024 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+
 apiVersion: apps/v1
 kind: Deployment
 metadata:
@@ -16,7 +19,7 @@ spec:
     spec:
       initContainers:
         - name: copy-ui-to-workdir
-          image: "insert-your-image-codegen-ui" 
+          image: "insert-your-image-codegen-ui"
           command:
             - /bin/bash
             - -c