You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-18Lines changed: 27 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,26 +25,35 @@ GenAIComps-based Generative AI examples offer streamlined deployment, testing, a
25
25
26
26
GenAIExamples offers flexible deployment options that cater to different user needs, enabling efficient use and deployment in various environments. Here’s a brief overview of the three primary methods: Python startup, Docker Compose, and Kubernetes.
27
27
28
-
1. <b>Docker Compose</b>: Check the released docker images in [docker image list](./docker_images_list.md) for detailed information.
29
-
2. <b>Kubernetes</b>: Follow the steps at [K8s Install](https://github.com/opea-project/docs/tree/main/guide/installation/k8s_install) and [GMC Install](https://github.com/opea-project/docs/blob/main/guide/installation/gmc_install/gmc_install.md) to setup k8s and GenAI environment .
30
-
31
28
Users can choose the most suitable approach based on ease of setup, scalability needs, and the environment in which they are operating.
32
29
33
-
### Deployment
34
-
35
-
| Use Case | Docker Compose<br/>Deployment on Xeon | Docker Compose<br/>Deployment on Gaudi | Kubernetes Deployment |
| AudioQnA |[Xeon Instructions](AudioQnA/docker/xeon/README.md)|[Gaudi Instructions](AudioQnA/docker/gaudi/README.md)| K8s Not Supported |
45
-
| VisualQnA |[Xeon Instructions](VisualQnA/docker/xeon/README.md)|[Gaudi Instructions](VisualQnA/docker/gaudi/README.md)| K8s Not Supported |
46
-
47
-
## Support Examples
30
+
### Deployment Guide
31
+
32
+
Deployment are based on released docker images by default, check [docker image list](./docker_images_list.md) for detailed information. You can also build your own images following instructions.
33
+
34
+
#### Prerequisite
35
+
36
+
- For Docker Compose based deployment, you should have docker compose installed. Refer to [docker compose install](https://docs.docker.com/compose/install/).
37
+
- For Kubernetes based deployment, we provide 3 ways from the easiest manifests to powerful [GMC](https://github.com/opea-project/GenAIInfra/tree/main/microservices-connector) based deployment.
38
+
- You should have a kubernetes cluster ready for use. If not, you can refer to [k8s install](https://github.com/opea-project/docs/tree/main/guide/installation/k8s_install) to deploy one.
39
+
- (Optional) You should have GMC installed to your kubernetes cluster if you want to try with GMC. Refer to [GMC install](https://github.com/opea-project/docs/blob/main/guide/installation/gmc_install/gmc_install.md) for more information.
40
+
- (Optional) You should have Helm (version >= 3.15) installed if you want to deploy with Helm Charts. Refer to the [Helm Installation Guide](https://helm.sh/docs/intro/install/) for more information.
41
+
42
+
#### Deploy Examples
43
+
44
+
| Use Case | Docker Compose<br/>Deployment on Xeon | Docker Compose<br/>Deployment on Gaudi | Kubernetes with GMC | Kubernetes with Manifests | Kubernetes with Helm Charts |
| ChatQnA |[Xeon Instructions](ChatQnA/docker/xeon/README.md)|[Gaudi Instructions](ChatQnA/docker/gaudi/README.md)|[ChatQnA with GMC](ChatQnA/kubernetes/README.md)|[ChatQnA with Manifests](ChatQnA/kubernetes/manifests/README.md)|[ChatQnA with Helm Charts](https://github.com/opea-project/GenAIInfra/tree/main/helm-charts/chatqna/README.md)|
47
+
| CodeGen |[Xeon Instructions](CodeGen/docker/xeon/README.md)|[Gaudi Instructions](CodeGen/docker/gaudi/README.md)|[CodeGen with GMC](CodeGen/kubernetes/README.md)|[CodeGen with Manifests](CodeGen/kubernetes/manifests/README.md)|[CodeGen with Helm Charts](https://github.com/opea-project/GenAIInfra/tree/main/helm-charts/codegen/README.md)|
48
+
| CodeTrans |[Xeon Instructions](CodeTrans/docker/xeon/README.md)|[Gaudi Instructions](CodeTrans/docker/gaudi/README.md)|[CodeTrans with GMC](CodeTrans/kubernetes/README.md)|[CodeTrans with Manifests](CodeTrans/kubernetes/manifests/README.md)|[CodeTrans with Helm Charts](https://github.com/opea-project/GenAIInfra/tree/main/helm-charts/codetrans/README.md)|
49
+
| DocSum |[Xeon Instructions](DocSum/docker/xeon/README.md)|[Gaudi Instructions](DocSum/docker/gaudi/README.md)|[DocSum with GMC](DocSum/kubernetes/README.md)|[DocSum with Manifests](DocSum/kubernetes/manifests/README.md)|[DocSum with Helm Charts](https://github.com/opea-project/GenAIInfra/tree/main/helm-charts/docsum/README.md)|
50
+
| SearchQnA |[Xeon Instructions](SearchQnA/docker/xeon/README.md)|[Gaudi Instructions](SearchQnA/docker/gaudi/README.md)|[SearchQnA with GMC](SearchQnA/kubernetes/README.md)| Not Supported | Not Supported |
51
+
| FaqGen |[Xeon Instructions](FaqGen/docker/xeon/README.md)|[Gaudi Instructions](FaqGen/docker/gaudi/README.md)|[FaqGen with GMC](FaqGen/kubernetes/README.md)| Not Supported | Not Supported |
52
+
| Translation |[Xeon Instructions](Translation/docker/xeon/README.md)|[Gaudi Instructions](Translation/docker/gaudi/README.md)|[Translation with GMC](Translation/kubernetes/README.md)| Not Supported | Not Supported |
53
+
| AudioQnA |[Xeon Instructions](AudioQnA/docker/xeon/README.md)|[Gaudi Instructions](AudioQnA/docker/gaudi/README.md)|[AudioQnA with GMC](AudioQnA/kubernetes/README.md)| Not Supported | Not Supported |
54
+
| VisualQnA |[Xeon Instructions](VisualQnA/docker/xeon/README.md)|[Gaudi Instructions](VisualQnA/docker/gaudi/README.md)|[VisualQnA with GMC](VisualQnA/kubernetes/README.md)| Not Supported | Not Supported |
55
+
56
+
## Supported Examples
48
57
49
58
Check [here](./supported_examples.md) for detailed information of supported examples, models, hardwares, etc.
0 commit comments