diff --git a/.github/dockerhub-readmes.json b/.github/dockerhub-readmes.json index d0386ae89..529d7ec05 100644 --- a/.github/dockerhub-readmes.json +++ b/.github/dockerhub-readmes.json @@ -39,6 +39,10 @@ { "fname": "./preset/README.md", "repo-name": "intel/inference-optimization" + }, + { + "fname": "./workflows/README.md", + "repo-name": "intel/ai-workflows" } ] } diff --git a/README.md b/README.md index 4ae07e787..0e1c9e74b 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8270/badge)](https://www.bestpractices.dev/projects/8270) [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/intel/ai-containers/badge)](https://securityscorecards.dev/viewer/?uri=github.com/intel/ai-containers) -[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fintel%2Fai-containers.svg?type=shield&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fintel%2Fai-containers?ref=badge_shield&issueType=license) -[![CodeQL](https://github.com/intel/ai-containers/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/intel/ai-containers/actions/workflows/github-code-scanning/codeql) [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/intel/ai-containers/main.svg)](https://results.pre-commit.ci/latest/github/intel/ai-containers/main) +[![CodeQL](https://github.com/intel/ai-containers/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/intel/ai-containers/actions/workflows/github-code-scanning/codeql) +[![Lint](https://github.com/intel/ai-containers/actions/workflows/lint.yaml/badge.svg)](https://github.com/intel/ai-containers/actions/workflows/lint.yaml) [![Test Runner CI](https://github.com/intel/ai-containers/actions/workflows/test-runner-ci.yaml/badge.svg)](https://github.com/intel/ai-containers/actions/workflows/test-runner-ci.yaml) [![Helm Chart CI](https://github.com/intel/ai-containers/actions/workflows/chart-ci.yaml/badge.svg)](https://github.com/intel/ai-containers/actions/workflows/chart-ci.yaml) [![Weekly Tests](https://github.com/intel/ai-containers/actions/workflows/weekly-test.yaml/badge.svg)](https://github.com/intel/ai-containers/actions/workflows/weekly-test.yaml) @@ -17,14 +17,18 @@ Define your project's registry and repository each time you use the project: ```bash # REGISTRY/REPO:TAG -export CACHE_REGISTRY= export REGISTRY= export REPO= ``` +The maintainers of Intel® AI Containers use [harbor](https://github.com/goharbor/harbor) to store containers. + > [!NOTE] > `REGISTRY` and `REPO` are used to authenticate with the private registry necessary to push completed container layers and saved them for testing and publication. For example: `REGISTRY=intel && REPO=intel-extension-for-pytorch` would become `intel/intel-extension-for-pytorch` as the name of the container image, followed by the tag generated from the service found in that project's compose file. +> [!WARNING] +> You can optionally skip this step and use some placeholder values, however some container groups depend on other images and will pull from a registry that you have not defined and result in an error. + ### Set Up Docker Engine You'll need to install Docker Engine on your development system. Note that while **Docker Engine** is free to use, **Docker Desktop** may require you to purchase a license. See the [Docker Engine Server installation instructions](https://docs.docker.com/engine/install/#server) for details. @@ -61,6 +65,9 @@ cd pytorch PACKAGE_OPTION=idp docker compose up --build ipex-base ``` +> [!NOTE] +> If you didn't specify `REGISTRY` or `REPO`, you also need to add the `idp` service to the list to build the dependent python image. + ## Test Containers To test the containers, use the [Test Runner Framework](https://github.com/intel/ai-containers/tree/main/test-runner): diff --git a/docs/README.md b/docs/README.md index c66782a12..87aad6814 100644 --- a/docs/README.md +++ b/docs/README.md @@ -24,6 +24,9 @@ mkdocs serve --no-livereload The documentation will be available at [http://localhost:8000](http://localhost:8000). +> [!CAUTION] +> Docker compose `v2.26.1` is the minimum required version. + ## Labelling Containers To customize the tables in the [Support Matrix](./matrix.md), you can add labels to the services found in each container group's `docker-compose.yaml` file. The command `docker compose config` is run to get all of the metadata from the container group. Labels are used to specify the public metadata for each container, and then the tables are generated based on the `.actions.json` file found in the same directory. diff --git a/docs/matrix.md b/docs/matrix.md index 1ffd1bc9a..6f5c47d82 100644 --- a/docs/matrix.md +++ b/docs/matrix.md @@ -1,13 +1,13 @@ # Support Matrix === "Framework Containers" - === "Python" + === "[Python](https://hub.docker.com/r/intel/python)" {{ read_csv('assets/python.csv') }} - === "Classical ML" + === "[Classical ML](https://hub.docker.com/r/intel/intel-optimized-ml)" {{ read_csv('assets/classical-ml.csv') }} - === "PyTorch" + === "[PyTorch](https://hub.docker.com/r/intel/intel-optimized-pytorch)" {{ read_csv('assets/pytorch.csv') }} - === "TensorFlow" + === "[TensorFlow](https://hub.docker.com/r/intel/intel-optimized-tensorflow)" {{ read_csv('assets/tensorflow.csv') }} === "Model Containers" @@ -22,7 +22,7 @@ === "Max" {{ read_csv('assets/max-pvc.csv') }} -=== "Preset Containers" +=== "[Preset Containers](https://github.com/intel/ai-containers/blob/main/preset/README.md)" === "Data Analytics" {{ read_csv('assets/data_analytics.csv') }} === "Classical ML" @@ -32,10 +32,8 @@ === "Inference Optimization" {{ read_csv('assets/inference_optimization.csv') }} -=== "Other" - === "Serving" +=== "[Workflows](https://hub.docker.com/r/intel/ai-workflows)" + === "[TorchServe](https://github.com/intel/ai-containers/tree/main/workflows/charts/torchserve)" {{ read_csv('assets/serving.csv') }} - === "Transformers" - {{ read_csv('assets/transformers.csv') }} - === "GenAI" + === "[Huggingface LLM](https://github.com/intel/ai-containers/tree/main/workflows/charts/huggingface-llm)" {{ read_csv('assets/genai.csv') }} diff --git a/docs/scripts/hook.py b/docs/scripts/hook.py index bbbf83cd3..fffa2b00e 100644 --- a/docs/scripts/hook.py +++ b/docs/scripts/hook.py @@ -40,8 +40,7 @@ def create_support_matrix(): # compose_to_csv("preset/classical-ml", "classical_ml") # compose_to_csv("preset/deep-learning", "deep_learning") # compose_to_csv("preset/inference-optimization", "inference_optimization") - # get_repo(transformers) - # get_repo(genai) + compose_to_csv("workflows/charts/huggingface-llm", "genai") def on_pre_build(*args, **kwargs): diff --git a/docs/scripts/matrix.py b/docs/scripts/matrix.py index bf1f0a01f..f03b49b93 100644 --- a/docs/scripts/matrix.py +++ b/docs/scripts/matrix.py @@ -174,7 +174,8 @@ def make_table(setting: str = None, compose_metadata: dict = None): metadata = extract_labels(setting) df = pd.concat([df, make_table(setting, metadata)], axis=1) else: - df = make_table() + metadata = docker.compose.config(return_json=True) + df = make_table("Name=Version", metadata) os.chdir(root) df.loc[:, ~df.columns.duplicated()].to_csv(f"docs/assets/{path}.csv", index=False) diff --git a/docs/scripts/readmes.py b/docs/scripts/readmes.py index 1e5debe2d..3e7d5e090 100644 --- a/docs/scripts/readmes.py +++ b/docs/scripts/readmes.py @@ -20,8 +20,8 @@ "preset/README.md", "python/README.md", "pytorch/README.md", - "pytorch/serving/README.md", "tensorflow/README.md", + "workflows/README.md", ] diff --git a/mkdocs.yml b/mkdocs.yml index 7fa0bd892..e593ef7f8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -13,7 +13,6 @@ # limitations under the License. copyright: Copyright © 2024 Intel Corporation -edit_uri: edit/main/docs/ extra: generator: false extra_javascript: @@ -37,15 +36,11 @@ nav: - Python Base: 'python/README.md' - PyTorch Base: 'pytorch/README.md' - TensorFlow Base: 'tensorflow/README.md' - - TorchServe: 'pytorch/serving/README.md' + - Workflows: 'workflows/README.md' - Support Matrix: 'matrix.md' - Roadmap: 'roadmap.md' plugins: - callouts -- git-authors -- git-revision-date-localized: - enable_creation_date: true - type: date # - optimize - search - table-reader: @@ -73,5 +68,4 @@ theme: - navigation.prune - toc.follow - toc.integrate - - content.action.edit name: material diff --git a/test-runner/README.md b/test-runner/README.md index 42e0ecf8a..6d6fd4786 100644 --- a/test-runner/README.md +++ b/test-runner/README.md @@ -277,3 +277,16 @@ See an [Example](../.github/workflows/test-runner-ci.yaml#L94) Implementation of > [!TIP] > When writing Tests for use with a CI platform like GitHub Actions, write your tests in such a way that they would be executed from the root directory of your repository. + +## Testing + +For testing [tests.yaml](tests.yaml) file, some variables need to be set + +```bash +export CACHE_REGISTRY= +export REGISTRY= +export REPO= +# optional +export PERF_REPO= +python test-runner/test_runner.py -f test-runner/tests.yaml -a test-runner/.actions.json +``` diff --git a/workflows/README.md b/workflows/README.md index 90a776e6f..21269eb7d 100644 --- a/workflows/README.md +++ b/workflows/README.md @@ -1,10 +1,36 @@ -# Workflows +# Intel® AI Workflows -This directory contains workflows demonstrating showing how the Intel Optimized base containers can be used for -different use cases: +Demonstrating showing how the [Intel® AI Containers] can be used for different use cases: ## PyTorch Workflows | Base Container | Device Type | Example | Description | |----------------|-------------|---------|-------------| -| `intel/intel-optimized-pytorch:2.3.0-pip-multinode` | CPU | [Distributed LLM Fine Tuning with Kubernetes](charts/huggingface-llm) | Demonstrates using Hugging Face Transformers with Intel® Xeon® Scalable Processors to fine tune LLMs with multiple nodes from a Kubernetes cluster. The example includes a LLM fine tuning script, Dockerfile, and Helm chart. | +| `intel/intel-optimized-pytorch:2.3.0-pip-multinode` | CPU | [Distributed LLM Fine Tuning with Kubernetes] | Demonstrates using Hugging Face Transformers with Intel® Xeon® Scalable Processors to fine tune LLMs with multiple nodes from a Kubernetes cluster. The example includes a LLM fine tuning script, Dockerfile, and Helm chart. | +| `intel/intel-optimized-pytorch:2.3.0-serving-cpu` | CPU | [TorchServe* with Kubernetes] | Demonstrates using TorchServe* with Intel® Xeon® Scalable Processors to serve models on multinodes nodes from a Kubernetes cluster. The example includes a Helm chart. | + +## Build from Source + +To build the images from source, clone the [Intel® AI Containers] repository, follow the main `README.md` file to setup your environment, and run the following command: + +```bash +cd workflows/charts/huggingface-llm +docker compose build huggingface-llm +docker compose run huggingface-llm sh -c "python /workspace/scripts/finetune.py --help" +``` + +## License + +View the [License](https://github.com/intel/ai-containers/blob/main/LICENSE) for the [Intel® AI Containers]. + +The images below also contain other software which may be under other licenses (such as Pytorch*, Jupyter*, Bash, etc. from the base). + +It is the image user's responsibility to ensure that any use of The images below comply with any relevant licenses for all software contained within. + +\* Other names and brands may be claimed as the property of others. + + + +[Intel® AI Containers]: https://github.com/intel/ai-containers +[Distributed LLM Fine Tuning with Kubernetes]: https://github.com/intel/ai-containers/tree/main/workflows/charts/huggingface-llm +[TorchServe* with Kubernetes]: https://github.com/intel/ai-containers/tree/main/workflows/charts/torchserve diff --git a/workflows/charts/huggingface-llm/docker-compose.yaml b/workflows/charts/huggingface-llm/docker-compose.yaml index 61f1d0b02..e1dba2135 100644 --- a/workflows/charts/huggingface-llm/docker-compose.yaml +++ b/workflows/charts/huggingface-llm/docker-compose.yaml @@ -23,8 +23,13 @@ services: BASE_IMAGE_TAG: ${BASE_IMAGE_TAG:-2.3.0-pip-multinode} context: . labels: + dependency.apt.google-perftools: true + dependency.apt.libjemalloc: true + dependency.apt.libomp-dev: true + dependency.apt.numactl: true + dependency.python: ${PYTHON_VERSION:-3.10} dependency.python.pip: requirements.txt - docs: pytorch + docs: genai org.opencontainers.base.name: "intel/intel-optimized-pytorch:${IPEX_VERSION:-2.3.0}-pip-multinode" org.opencontainers.image.name: "intel/ai-workflows" org.opencontainers.image.title: "Intel® Extension for PyTorch with Hugging Face LLM fine tuning" diff --git a/workflows/charts/test/.helmignore b/workflows/charts/test/.helmignore deleted file mode 100644 index 0e8a0eb36..000000000 --- a/workflows/charts/test/.helmignore +++ /dev/null @@ -1,23 +0,0 @@ -# Patterns to ignore when building packages. -# This supports shell glob matching, relative path matching, and -# negation (prefixed with !). Only one pattern per line. -.DS_Store -# Common VCS dirs -.git/ -.gitignore -.bzr/ -.bzrignore -.hg/ -.hgignore -.svn/ -# Common backup files -*.swp -*.bak -*.tmp -*.orig -*~ -# Various IDEs -.project -.idea/ -*.tmproj -.vscode/ diff --git a/workflows/charts/test/Chart.yaml b/workflows/charts/test/Chart.yaml deleted file mode 100644 index 76e8468a9..000000000 --- a/workflows/charts/test/Chart.yaml +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright (c) 2024 Intel Corporation -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -apiVersion: v2 -name: chart-test -description: A Helm chart for Kubernetes - -# A chart can be either an 'application' or a 'library' chart. -# -# Application charts are a collection of templates that can be packaged into versioned archives -# to be deployed. -# -# Library charts provide useful utilities or functions for the chart developer. They're included as -# a dependency of application charts to inject those utilities and functions into the rendering -# pipeline. Library charts do not define any templates and therefore cannot be deployed. -maintainers: - - name: tylertitsworth - email: tyler.titsworth@intel.com - url: https://github.com/tylertitsworth -type: application - -# This is the chart version. This version number should be incremented each time you make changes -# to the chart and its templates, including the app version. -# Versions are expected to follow Semantic Versioning (https://semver.org/) -version: 0.1.0 - -# This is the version number of the application being deployed. This version number should be -# incremented each time you make changes to the application. Versions are not expected to -# follow Semantic Versioning. They should reflect the version the application is using. -# It is recommended to use it with quotes. -appVersion: "1.16.0" diff --git a/workflows/charts/test/README.md b/workflows/charts/test/README.md deleted file mode 100644 index 989ae5fe9..000000000 --- a/workflows/charts/test/README.md +++ /dev/null @@ -1,30 +0,0 @@ -# chart-test - -![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.16.0](https://img.shields.io/badge/AppVersion-1.16.0-informational?style=flat-square) - -A Helm chart for Kubernetes - -## Maintainers - -| Name | Email | Url | -| ---- | ------ | --- | -| tylertitsworth | | | - -## Values - -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| fullnameOverride | string | `""` | | -| image.pullPolicy | string | `"IfNotPresent"` | | -| image.repository | string | `"nginx"` | | -| image.tag | string | `""` | | -| nameOverride | string | `""` | | -| replicaCount | int | `1` | | -| service.port | int | `80` | | -| service.type | string | `"ClusterIP"` | | -| serviceAccount.annotations | object | `{}` | | -| serviceAccount.create | bool | `true` | | -| serviceAccount.name | string | `""` | | - ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1) diff --git a/workflows/charts/test/templates/NOTES.txt b/workflows/charts/test/templates/NOTES.txt deleted file mode 100644 index 4d1369eac..000000000 --- a/workflows/charts/test/templates/NOTES.txt +++ /dev/null @@ -1,16 +0,0 @@ -1. Get the application URL by running these commands: -{{- if contains "NodePort" .Values.service.type }} - export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "chart-test.fullname" . }}) - export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") - echo http://$NODE_IP:$NODE_PORT -{{- else if contains "LoadBalancer" .Values.service.type }} - NOTE: It may take a few minutes for the LoadBalancer IP to be available. - You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "chart-test.fullname" . }}' - export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "chart-test.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}") - echo http://$SERVICE_IP:{{ .Values.service.port }} -{{- else if contains "ClusterIP" .Values.service.type }} - export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "chart-test.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") - export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}") - echo "Visit http://127.0.0.1:8080 to use your application" - kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT -{{- end }} diff --git a/workflows/charts/test/templates/_helpers.tpl b/workflows/charts/test/templates/_helpers.tpl deleted file mode 100644 index 9e23fffb4..000000000 --- a/workflows/charts/test/templates/_helpers.tpl +++ /dev/null @@ -1,62 +0,0 @@ -{{/* -Expand the name of the chart. -*/}} -{{- define "chart-test.name" -}} -{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }} -{{- end }} - -{{/* -Create a default fully qualified app name. -We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). -If release name contains chart name it will be used as a full name. -*/}} -{{- define "chart-test.fullname" -}} -{{- if .Values.fullnameOverride }} -{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }} -{{- else }} -{{- $name := default .Chart.Name .Values.nameOverride }} -{{- if contains $name .Release.Name }} -{{- .Release.Name | trunc 63 | trimSuffix "-" }} -{{- else }} -{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }} -{{- end }} -{{- end }} -{{- end }} - -{{/* -Create chart name and version as used by the chart label. -*/}} -{{- define "chart-test.chart" -}} -{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} -{{- end }} - -{{/* -Common labels -*/}} -{{- define "chart-test.labels" -}} -helm.sh/chart: {{ include "chart-test.chart" . }} -{{ include "chart-test.selectorLabels" . }} -{{- if .Chart.AppVersion }} -app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} -{{- end }} -app.kubernetes.io/managed-by: {{ .Release.Service }} -{{- end }} - -{{/* -Selector labels -*/}} -{{- define "chart-test.selectorLabels" -}} -app.kubernetes.io/name: {{ include "chart-test.name" . }} -app.kubernetes.io/instance: {{ .Release.Name }} -{{- end }} - -{{/* -Create the name of the service account to use -*/}} -{{- define "chart-test.serviceAccountName" -}} -{{- if .Values.serviceAccount.create }} -{{- default (include "chart-test.fullname" .) .Values.serviceAccount.name }} -{{- else }} -{{- default "default" .Values.serviceAccount.name }} -{{- end }} -{{- end }} diff --git a/workflows/charts/test/templates/deployment.yaml b/workflows/charts/test/templates/deployment.yaml deleted file mode 100644 index 05174bb2c..000000000 --- a/workflows/charts/test/templates/deployment.yaml +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright (c) 2024 Intel Corporation -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -apiVersion: apps/v1 -kind: Deployment -metadata: - name: {{ include "chart-test.fullname" . }} - labels: - {{- include "chart-test.labels" . | nindent 4 }} -spec: - replicas: {{ .Values.replicaCount }} - selector: - matchLabels: - {{- include "chart-test.selectorLabels" . | nindent 6 }} - template: - metadata: - labels: - {{- include "chart-test.selectorLabels" . | nindent 8 }} - spec: - serviceAccountName: {{ include "chart-test.serviceAccountName" . }} - containers: - - name: {{ .Chart.Name }} - image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}" - imagePullPolicy: {{ .Values.image.pullPolicy }} - ports: - - name: http - containerPort: 80 - protocol: TCP - livenessProbe: - httpGet: - path: / - port: http - readinessProbe: - httpGet: - path: / - port: http diff --git a/workflows/charts/test/templates/service.yaml b/workflows/charts/test/templates/service.yaml deleted file mode 100644 index 2a5d21f87..000000000 --- a/workflows/charts/test/templates/service.yaml +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright (c) 2024 Intel Corporation -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -apiVersion: v1 -kind: Service -metadata: - name: {{ include "chart-test.fullname" . }} - labels: - {{- include "chart-test.labels" . | nindent 4 }} -spec: - type: {{ .Values.service.type }} - ports: - - port: {{ .Values.service.port }} - targetPort: http - protocol: TCP - name: http - selector: - {{- include "chart-test.selectorLabels" . | nindent 4 }} diff --git a/workflows/charts/test/templates/serviceaccount.yaml b/workflows/charts/test/templates/serviceaccount.yaml deleted file mode 100644 index 52ecc7b55..000000000 --- a/workflows/charts/test/templates/serviceaccount.yaml +++ /dev/null @@ -1,26 +0,0 @@ -# Copyright (c) 2024 Intel Corporation -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -{{if .Values.serviceAccount.create -}} -apiVersion: v1 -kind: ServiceAccount -metadata: - name: {{ include "chart-test.serviceAccountName" . }} - labels: - {{- include "chart-test.labels" . | nindent 4 }} - {{- with .Values.serviceAccount.annotations }} - annotations: - {{- toYaml . | nindent 4 }} - {{- end }} -{{- end }} diff --git a/workflows/charts/test/templates/tests/test-connection.yaml b/workflows/charts/test/templates/tests/test-connection.yaml deleted file mode 100644 index eb4466f38..000000000 --- a/workflows/charts/test/templates/tests/test-connection.yaml +++ /dev/null @@ -1,30 +0,0 @@ -# yamllint disable-file -# Copyright (c) 2024 Intel Corporation -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -apiVersion: v1 -kind: Pod -metadata: - name: "{{ include "chart-test.fullname" . }}-test-connection" - labels: - {{- include "chart-test.labels" . | nindent 4 }} - annotations: - "helm.sh/hook": test -spec: - containers: - - name: wget - image: busybox - command: ['wget'] - args: ['{{ include "chart-test.fullname" . }}:{{ .Values.service.port }}'] - restartPolicy: Never diff --git a/workflows/charts/test/values.yaml b/workflows/charts/test/values.yaml deleted file mode 100644 index 479b2dd3c..000000000 --- a/workflows/charts/test/values.yaml +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright (c) 2024 Intel Corporation -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Default values for chart-test. -# This is a YAML-formatted file. -# Declare variables to be passed into your templates. - -replicaCount: 1 - -image: - repository: nginx - pullPolicy: IfNotPresent - # Overrides the image tag whose default is the chart appVersion. - tag: "" - -nameOverride: "" -fullnameOverride: "" - -serviceAccount: - # Specifies whether a service account should be created - create: true - # Annotations to add to the service account - annotations: {} - # The name of the service account to use. - # If not set and create is true, a name is generated using the fullname template - name: "" - -service: - type: ClusterIP - port: 80 diff --git a/workflows/charts/torchserve/README.md b/workflows/charts/torchserve/README.md index c51ea7211..b84a964c2 100644 --- a/workflows/charts/torchserve/README.md +++ b/workflows/charts/torchserve/README.md @@ -2,6 +2,8 @@ Intel TorchServe is a performant, flexible and easy to use tool for serving PyTorch models in production. +For more information about how to use Intel Optimized TorchServe, check out the [container documentation](../../../pytorch/serving/README.md). + ![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.16.0](https://img.shields.io/badge/AppVersion-1.16.0-informational?style=flat-square) ## Values diff --git a/workflows/charts/torchserve/README.md.gotmpl b/workflows/charts/torchserve/README.md.gotmpl index 8609edfab..1ddf329d3 100644 --- a/workflows/charts/torchserve/README.md.gotmpl +++ b/workflows/charts/torchserve/README.md.gotmpl @@ -2,6 +2,8 @@ {{ template "chart.description" . }} +For more information about how to use Intel Optimized TorchServe, check out the [container documentation](../../../pytorch/serving/README.md). + {{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} {{ template "chart.requirementsSection" . }}