docs: update repo links, citations (#1990)

* docs: update project links

...

* docs: update citation
This commit is contained in:
Javier Martinez 2024-07-09 10:03:57 +02:00 committed by GitHub
parent 187bc9320e
commit 15f73dbc48
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 15 additions and 24 deletions

View File

@ -8,18 +8,9 @@ message: >-
metadata from this file. metadata from this file.
type: software type: software
authors: authors:
- given-names: Iván - name: Zylon by PrivateGPT
family-names: Martínez Toro address: hello@zylon.ai
email: ivanmartit@gmail.com website: 'https://www.zylon.ai/'
orcid: 'https://orcid.org/0009-0004-5065-2311' repository-code: 'https://github.com/zylon-ai/private-gpt'
- family-names: Gallego Vico
given-names: Daniel
email: danielgallegovico@gmail.com
orcid: 'https://orcid.org/0009-0006-8582-4384'
- given-names: Pablo
family-names: Orgaz
email: pabloogc+gh@gmail.com
orcid: 'https://orcid.org/0009-0008-0080-1437'
repository-code: 'https://github.com/imartinez/privateGPT'
license: Apache-2.0 license: Apache-2.0
date-released: '2023-05-02' date-released: '2023-05-02'

View File

@ -1,6 +1,6 @@
# 🔒 PrivateGPT 📑 # 🔒 PrivateGPT 📑
[![Tests](https://github.com/imartinez/privateGPT/actions/workflows/tests.yml/badge.svg)](https://github.com/imartinez/privateGPT/actions/workflows/tests.yml?query=branch%3Amain) [![Tests](https://github.com/zylon-ai/private-gpt/actions/workflows/tests.yml/badge.svg)](https://github.com/zylon-ai/private-gpt/actions/workflows/tests.yml?query=branch%3Amain)
[![Website](https://img.shields.io/website?up_message=check%20it&down_message=down&url=https%3A%2F%2Fdocs.privategpt.dev%2F&label=Documentation)](https://docs.privategpt.dev/) [![Website](https://img.shields.io/website?up_message=check%20it&down_message=down&url=https%3A%2F%2Fdocs.privategpt.dev%2F&label=Documentation)](https://docs.privategpt.dev/)
[![Discord](https://img.shields.io/discord/1164200432894234644?logo=discord&label=PrivateGPT)](https://discord.gg/bK6mRVpErU) [![Discord](https://img.shields.io/discord/1164200432894234644?logo=discord&label=PrivateGPT)](https://discord.gg/bK6mRVpErU)
@ -9,7 +9,7 @@
> Install & usage docs: https://docs.privategpt.dev/ > Install & usage docs: https://docs.privategpt.dev/
> >
> Join the community: [Twitter](https://twitter.com/PrivateGPT_AI) & [Discord](https://discord.gg/bK6mRVpErU) > Join the community: [Twitter](https://twitter.com/ZylonPrivateGPT) & [Discord](https://discord.gg/bK6mRVpErU)
![Gradio UI](/fern/docs/assets/ui.png?raw=true) ![Gradio UI](/fern/docs/assets/ui.png?raw=true)
@ -62,7 +62,7 @@ thus a simpler and more educational implementation to understand the basic conce
to build a fully local -and therefore, private- chatGPT-like tool. to build a fully local -and therefore, private- chatGPT-like tool.
If you want to keep experimenting with it, we have saved it in the If you want to keep experimenting with it, we have saved it in the
[primordial branch](https://github.com/imartinez/privateGPT/tree/primordial) of the project. [primordial branch](https://github.com/zylon-ai/private-gpt/tree/primordial) of the project.
> It is strongly recommended to do a clean clone and install of this new version of > It is strongly recommended to do a clean clone and install of this new version of
PrivateGPT if you come from the previous, primordial version. PrivateGPT if you come from the previous, primordial version.
@ -73,7 +73,7 @@ completions, document ingestion, RAG pipelines and other low-level building bloc
We want to make it easier for any developer to build AI applications and experiences, as well as provide We want to make it easier for any developer to build AI applications and experiences, as well as provide
a suitable extensive architecture for the community to keep contributing. a suitable extensive architecture for the community to keep contributing.
Stay tuned to our [releases](https://github.com/imartinez/privateGPT/releases) to check out all the new features and changes included. Stay tuned to our [releases](https://github.com/zylon-ai/private-gpt/releases) to check out all the new features and changes included.
## 📄 Documentation ## 📄 Documentation
Full documentation on installation, dependencies, configuration, running the server, deployment options, Full documentation on installation, dependencies, configuration, running the server, deployment options,
@ -132,19 +132,19 @@ Here are a couple of examples:
#### BibTeX #### BibTeX
```bibtex ```bibtex
@software{Martinez_Toro_PrivateGPT_2023, @software{Zylon_PrivateGPT_2023,
author = {Martínez Toro, Iván and Gallego Vico, Daniel and Orgaz, Pablo}, author = {Zylon by PrivateGPT},
license = {Apache-2.0}, license = {Apache-2.0},
month = may, month = may,
title = {{PrivateGPT}}, title = {{PrivateGPT}},
url = {https://github.com/imartinez/privateGPT}, url = {https://github.com/zylon-ai/private-gpt},
year = {2023} year = {2023}
} }
``` ```
#### APA #### APA
``` ```
Martínez Toro, I., Gallego Vico, D., & Orgaz, P. (2023). PrivateGPT [Computer software]. https://github.com/imartinez/privateGPT Zylon by PrivateGPT (2023). PrivateGPT [Computer software]. https://github.com/zylon-ai/private-gpt
``` ```
## 🤗 Partners & Supporters ## 🤗 Partners & Supporters

View File

@ -96,7 +96,7 @@ navbar-links:
text: Contact us text: Contact us
url: "mailto:hello@zylon.ai" url: "mailto:hello@zylon.ai"
- type: github - type: github
value: "https://github.com/imartinez/privateGPT" value: "https://github.com/zylon-ai/private-gpt"
- type: primary - type: primary
text: Join the Discord text: Join the Discord
url: https://discord.com/invite/bK6mRVpErU url: https://discord.com/invite/bK6mRVpErU

View File

@ -26,12 +26,12 @@ The clients are kept up to date automatically, so we encourage you to use the la
<Card <Card
title="Java - WIP" title="Java - WIP"
icon="fa-brands fa-java" icon="fa-brands fa-java"
href="https://github.com/imartinez/privateGPT-java" href="https://github.com/zylon-ai/private-gpt-java"
/> />
<Card <Card
title="Go - WIP" title="Go - WIP"
icon="fa-brands fa-golang" icon="fa-brands fa-golang"
href="https://github.com/imartinez/privateGPT-go" href="https://github.com/zylon-ai/private-gpt-go"
/> />
</Cards> </Cards>