24-05-24 OPEA-001 Code Structureยถ
Statusยถ
Under Review
Objectiveยถ
Define a clear criteria and rule of adding new codes into OPEA projects.
Motivationยถ
OPEA project consists of serveral repos, including GenAIExamples, GenAIInfra, GenAICompos, and so on. We need a clear definition on where the new code for a given feature should be put for a consistent and well-orgnized code structure.
Design Proposalยถ
The proposed code structure of GenAIInfra is:
GenAIInfra/
โโโ kubernetes-addon/ # the folder implementing additional operational capabilities to Kubernetes applications
โโโ microservices-connector/ # the folder containing the implementation of microservice connector on Kubernetes
โโโ scripts/
The proposed code structure of GenAIExamples is:
GenAIExamples/
โโโ ChatQnA/
โโโ kubernetes/
โ โโโ manifests
โ โโโ microservices-connector
โโโ docker/
โ โโโ docker_compose.yaml
โ โโโ dockerfile
โ โโโ chatqna.py
โโโ chatqna.yaml # The MegaService Yaml
โโโ README.md
The proposed code structure of GenAIComps is:
GenAIComps/
โโโ comps/
โโโ llms/
โโโ text-generation/
โ โโโ tgi-gaudi/
โ โ โโโ dockerfile
โ โ โโโ llm.py
โ โโโ tgi-xeon/
โ โ โโโ dockerfile
โ โ โโโ llm.py
โ โโโ vllm-gaudi
โ โโโ ray
โ โโโ langchain
โโโ text-summarization/
Miscsยถ
n/a