mirror of
https://github.com/imartinez/privateGPT.git
synced 2025-07-04 02:56:41 +00:00
docs: update docs and capture (#2029)
* docs: update Readme * style: refactor image * docs: change important to tip
This commit is contained in:
parent
54659588b5
commit
50b3027a24
22
README.md
22
README.md
@ -2,21 +2,21 @@
|
|||||||
|
|
||||||
[](https://github.com/zylon-ai/private-gpt/actions/workflows/tests.yml?query=branch%3Amain)
|
[](https://github.com/zylon-ai/private-gpt/actions/workflows/tests.yml?query=branch%3Amain)
|
||||||
[](https://docs.privategpt.dev/)
|
[](https://docs.privategpt.dev/)
|
||||||
|
|
||||||
[](https://discord.gg/bK6mRVpErU)
|
[](https://discord.gg/bK6mRVpErU)
|
||||||
[](https://twitter.com/ZylonPrivateGPT)
|
[](https://twitter.com/ZylonPrivateGPT)
|
||||||
|
|
||||||
|
|
||||||
> Install & usage docs: https://docs.privategpt.dev/
|
|
||||||
>
|
|
||||||
> Join the community: [Twitter](https://twitter.com/ZylonPrivateGPT) & [Discord](https://discord.gg/bK6mRVpErU)
|
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
PrivateGPT is a production-ready AI project that allows you to ask questions about your documents using the power
|
PrivateGPT is a production-ready AI project that allows you to ask questions about your documents using the power
|
||||||
of Large Language Models (LLMs), even in scenarios without an Internet connection. 100% private, no data leaves your
|
of Large Language Models (LLMs), even in scenarios without an Internet connection. 100% private, no data leaves your
|
||||||
execution environment at any point.
|
execution environment at any point.
|
||||||
|
|
||||||
|
>[!TIP]
|
||||||
|
> If you are looking for an **enterprise-ready, fully private AI workspace**
|
||||||
|
> check out [Zylon's website](https://zylon.ai) or [request a demo](https://cal.com/zylon/demo?source=pgpt-readme).
|
||||||
|
> Crafted by the team behind PrivateGPT, Zylon is a best-in-class AI collaborative
|
||||||
|
> workspace that can be easily deployed on-premise (data center, bare metal...) or in your private cloud (AWS, GCP, Azure...).
|
||||||
|
|
||||||
The project provides an API offering all the primitives required to build private, context-aware AI applications.
|
The project provides an API offering all the primitives required to build private, context-aware AI applications.
|
||||||
It follows and extends the [OpenAI API standard](https://openai.com/blog/openai-api),
|
It follows and extends the [OpenAI API standard](https://openai.com/blog/openai-api),
|
||||||
and supports both normal and streaming responses.
|
and supports both normal and streaming responses.
|
||||||
@ -38,14 +38,10 @@ In addition to this, a working [Gradio UI](https://www.gradio.app/)
|
|||||||
client is provided to test the API, together with a set of useful tools such as bulk model
|
client is provided to test the API, together with a set of useful tools such as bulk model
|
||||||
download script, ingestion script, documents folder watch, etc.
|
download script, ingestion script, documents folder watch, etc.
|
||||||
|
|
||||||
> 💡 If you are looking for an **enterprise-ready, fully private AI workspace**
|
|
||||||
> check out [Zylon's website](https://zylon.ai) or [request a demo](https://cal.com/zylon/demo?source=pgpt-readme).
|
|
||||||
> Crafted by the team behind PrivateGPT, Zylon is a best-in-class AI collaborative
|
|
||||||
> workspace that can be easily deployed on-premise (data center, bare metal...) or in your private cloud (AWS, GCP, Azure...).
|
|
||||||
|
|
||||||
## 🎞️ Overview
|
## 🎞️ Overview
|
||||||
DISCLAIMER: This README is not updated as frequently as the [documentation](https://docs.privategpt.dev/).
|
>[!WARNING]
|
||||||
Please check it out for the latest updates!
|
> This README is not updated as frequently as the [documentation](https://docs.privategpt.dev/).
|
||||||
|
> Please check it out for the latest updates!
|
||||||
|
|
||||||
### Motivation behind PrivateGPT
|
### Motivation behind PrivateGPT
|
||||||
Generative AI is a game changer for our society, but adoption in companies of all sizes and data-sensitive
|
Generative AI is a game changer for our society, but adoption in companies of all sizes and data-sensitive
|
||||||
|
Binary file not shown.
Before Width: | Height: | Size: 212 KiB After Width: | Height: | Size: 154 KiB |
Loading…
Reference in New Issue
Block a user