Skip to content

Commit

Permalink
Add top readme (opea-project#33)
Browse files Browse the repository at this point in the history
* Add README

Signed-off-by: lvliang-intel <liang1.lv@intel.com>
---------

Signed-off-by: lvliang-intel <liang1.lv@intel.com>
Co-authored-by: hshen14 <haihao.shen@intel.com>
  • Loading branch information
lvliang-intel and hshen14 authored May 10, 2024
1 parent 170c21c commit 592ce60
Show file tree
Hide file tree
Showing 4 changed files with 200 additions and 2 deletions.
53 changes: 53 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Contributing

## License

Generative AI Examples is licensed under the terms in [LICENSE](/LICENSE).
By contributing to the project, you agree to the license and copyright terms therein and release your contribution under these terms.

## Create Pull Request

If you have improvements to Generative AI Examples, send your pull requests for
[review](https://github.com/opea-project/GenAIExamples/pulls).
If you are new to GitHub, view the pull request [How To](https://help.github.com/articles/using-pull-requests/).

### Step-by-Step guidelines

- Star this repository using the button `Star` in the top right corner.
- Fork this Repository using the button `Fork` in the top right corner.
- Clone your forked repository to your pc.
`git clone "url to your repo"`
- Create a new branch for your modifications.
`git checkout -b new-branch`
- Add your files with `git add -A`, commit with `git commit -s -m "This is my commit message"` and push `git push origin new-branch`.
- Create a [pull request](https://github.com/opea-project/GenAIExamples/pulls).

## Pull Request Template

See [PR template](/.github/pull_request_template.md)

## Pull Request Acceptance Criteria

- At least two approvals from reviewers

- All detected status checks pass

- All conversations solved

- Third-party dependency license compatible

## Pull Request Status Checks Overview

Generative AI Examples use [Actions](https://github.com/opea-project/GenAIExamples/actions) for CI test.
| Test Name | Test Scope | Test Pass Criteria |
|-------------------------------|-----------------------------------------------|---------------------------|
| Security Scan | Dependabot/Bandit | PASS |
| Format Scan | pre-commit.ci | PASS |
| Examples Test | Cases under Examples/tests folder | PASS |
| DCO | Use `git commit -s` to sign off | PASS |

> Notes: [Developer Certificate of Origin (DCO)](https://en.wikipedia.org/wiki/Developer_Certificate_of_Origin), you must agree to the terms of Developer Certificate of Origin by signing off each of your commits with `-s`, e.g. `git commit -s -m 'This is my commit message'`.
## Support

Submit your questions, feature requests, and bug reports to the [GitHub issues](https://github.com/opea-project/GenAIExamples/issues) page.
37 changes: 37 additions & 0 deletions LEGAL_INFORMATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Legal Information

1. [License](#license)
2. [Citation](#citation)
3. [Trademarks](#trademarks)

## License

Generative AI Examples is licensed under [Apache License Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
This software includes components that have separate copyright notices and licensing terms.
Your use of the source code for these components is subject to the terms and conditions of the following licenses.

- [Third Party Programs](/third-party-programs.txt)

See the accompanying [license](/LICENSE) file for full license text and copyright notices.

## Citation

If you use Generative AI Examples in your research, use the following BibTeX entry.

```
@misc{Generative AI Examples,
author = {Liang Lv, Haihao Shen},
title = {Generative AI Examples},
howpublished = {\url{https://github.com/opea-project/GenAIExamples}},
year = {2024}
}
```

## Trademarks

Intel, the Intel logo, Intel Atom, Intel Core, Intel Xeon Phi, Pentium,
VTune, and Xeon are trademarks of Intel Corporation or its subsidiaries.

\* Other names and brands may be claimed as the property of others.

Copyright, Intel Corporation
99 changes: 97 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,98 @@
# GenAIComps
<div align="center">

GenAI components at micro-service level; GenAI service composer to create mega-service
# Generative AI Components (GenAIComps)

<p align="center">
<b>Build Enterprise-grade Generative AI applications with microservice architecture</b>
</p>

<div align="left">

This initiative empowers the development of high-quality Generative AI applications for enterprises via microservices, simplifying the scaling and deployment process for production. It abstracts away infrastructure complexities, facilitating the seamless development and deployment of Enterprise AI services.

## GenAIComps

GenAIComps provides a suite of microservices, leveraging a service composer to assemble a mega-service tailored for real-world Enterprise AI applications. All the microservices are containerized, allowing cloud native deployment. Checkout how the microservices are used in [GenAIExamples](https://github.com/opea-project/GenAIExamples)).

![Architecture](https://i.imgur.com/r5J0i8j.png)

## MicroService

The initially supported microservices are described in the below table. More microservices are on the way.

<table>
<tbody>
<tr>
<td>MicroService</td>
<td>Framework</td>
<td>Model</td>
<td>Serving</td>
<td>HW</td>
<td>Description</td>
</tr>
<tr>
<td><a href="./comps/embeddings/README.md">Embedding</a></td>
<td><a href="https://www.langchain.com">LangChain</a></td>
<td><a href="https://huggingface.co/BAAI/bge-large-en-v1.5">BAAI/bge-large-en-v1.5</a></td>
<td><a href="https://github.com/huggingface/tei-gaudi">TEI-Habana</a></td>
<td>Gaudi2</td>
<td>Embedding on Gaudi2</td>
</tr>
<tr>
<td><a href="./comps/embeddings/README.md">Embedding</a></td>
<td><a href="https://www.langchain.com">LangChain</a></td>
<td><a href="https://huggingface.co/BAAI/bge-base-en-v1.5">BAAI/bge-base-en-v1.5</a></td>
<td><a href="https://github.com/huggingface/text-embeddings-inference">TEI</a></td>
<td>Xeon</td>
<td>Embedding on Xeon CPU</td>
</tr>
<tr>
<td><a href="./comps/retrievers/README.md">Retriever</a></td>
<td><a href="https://www.langchain.com">LangChain</a></td>
<td><a href="https://huggingface.co/BAAI/bge-base-en-v1.5">BAAI/bge-base-en-v1.5</a></td>
<td><a href="https://github.com/huggingface/text-embeddings-inference">TEI</a></td>
<td>Xeon</td>
<td>Retriever on Xeon CPU</td>
</tr>
<tr>
<td><a href="./comps/reranks/README.md">Reranking</a></td>
<td><a href="https://www.langchain.com">LangChain</a></td>
<td><a href="https://huggingface.co/BAAI/bge-reranker-large">BAAI/bge-reranker-large</a></td>
<td><a href="https://github.com/huggingface/tei-gaudi">TEI-Habana</a></td>
<td>Gaudi2</td>
<td>Reranking on Gaudi2</td>
</tr>
<tr>
<td><a href="./comps/reranks/README.md">Reranking</a></td>
<td><a href="https://www.langchain.com">LangChain</a></td>
<td><a href="https://huggingface.co/BAAI/bge-reranker-base">BBAAI/bge-reranker-base</a></td>
<td><a href="https://github.com/huggingface/text-embeddings-inference">TEI</a></td>
<td>Xeon</td>
<td>Reranking on Xeon CPU</td>
</tr>
<tr>
<td><a href="./comps/llms/README.md">LLM</a></td>
<td><a href="https://www.langchain.com">LangChain</a></td>
<td><a href="https://huggingface.co/Intel/neural-chat-7b-v3-3">Intel/neural-chat-7b-v3-3</a></td>
<td><a href="https://github.com/huggingface/tgi-gaudi">TGI Gaudi</a></td>
<td>Gaudi2</td>
<td>LLM on Gaudi2</td>
</tr>
<tr>
<td><a href="./comps/llms/README.md">LLM</a></td>
<td><a href="https://www.langchain.com">LangChain</a></td>
<td><a href="https://huggingface.co/Intel/neural-chat-7b-v3-3">Intel/neural-chat-7b-v3-3</a></td>
<td><a href="https://github.com/huggingface/text-generation-inference">TGI</a></td>
<td>Xeon</td>
<td>LLM on Xeon CPU</td>
</tr>
</tbody>
</table>

## MegaService (under construction)

## Additional Content

- [Contribution](/CONTRIBUTING.md)
- [Legal Information](/LEGAL_INFORMATION.md)
- [Security Policy](/SECURITY.md)
13 changes: 13 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Security Policy

Intel is committed to rapidly addressing security vulnerabilities affecting our customers and providing clear guidance on the solution, impact, severity and mitigation.

## Reporting a Vulnerability

Please report any security vulnerabilities in this project utilizing the guidelines [here](https://www.intel.com/content/www/us/en/security-center/vulnerability-handling-guidelines.html).

## Script Usage Notice

SCRIPT USAGE NOTICE: By downloading and using any script file included with the associated software package (such as files with .bat, .cmd, or .JS extensions, Dockerfiles, or any other type of file that, when executed, automatically downloads and/or installs files onto your system)
(the “Script File”), it is your obligation to review the Script File to understand what files (e.g., other software, AI models, AI Datasets) the Script File will download to your system (“Downloaded Files”).
Furthermore, by downloading and using the Downloaded Files, even if they are installed through a silent install, you agree to any and all terms and conditions associated with such files, including but not limited to, license terms, notices, or disclaimers.

0 comments on commit 592ce60

Please sign in to comment.