From 104516bd89dee3e9507ec9af240f14d59faec9b7 Mon Sep 17 00:00:00 2001 From: Daniel Chalef <131175+danielchalef@users.noreply.github.com> Date: Sun, 2 Feb 2025 09:20:26 -0800 Subject: [PATCH] docs: update README to enhance clarity and add Zep Memory section (#260) * docs: update README to enhance clarity and add Zep Memory section * docs: fix formatting in README for clarity on Zep's memory capabilities * docs: add hyperlink to arXiv paper in README for improved accessibility --- README.md | 34 +++++++++++++++++++--------------- images/arxiv-screenshot.png | Bin 0 -> 535574 bytes 2 files changed, 19 insertions(+), 15 deletions(-) create mode 100644 images/arxiv-screenshot.png diff --git a/README.md b/README.md index 4ba23f95..a3740e2e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@
-
+
-## Graphiti and Zep Memory
-
-Graphiti powers the core of [Zep's memory layer](https://www.getzep.com) for LLM-powered Assistants and Agents.
-
-We're excited to open-source Graphiti, believing its potential reaches far beyond memory applications.
-
## Installation
Requirements:
@@ -103,7 +111,7 @@ poetry add graphiti-core
> [!IMPORTANT]
> Graphiti uses OpenAI for LLM inference and embedding. Ensure that an `OPENAI_API_KEY` is set in your environment.
-> Support for Anthropic and Groq LLM inferences is available, too.
+> Support for Anthropic and Groq LLM inferences is available, too. Other LLM providers may be supported via OpenAI compatible APIs.
```python
from graphiti_core import Graphiti
@@ -194,13 +202,9 @@ as such this feature is off by default.
Graphiti is under active development. We aim to maintain API stability while working on:
-- [x] Implementing node and edge CRUD operations
-- [ ] Improving performance and scalability
-- [ ] Achieving good performance with different LLM and embedding models
-- [x] Creating a dedicated embedder interface
- [ ] Supporting custom graph schemas:
- - Allow developers to provide their own defined node and edge classes when ingesting episodes
- - Enable more flexible knowledge representation tailored to specific use cases
+ - Allow developers to provide their own defined node and edge classes when ingesting episodes
+ - Enable more flexible knowledge representation tailored to specific use cases
- [x] Enhancing retrieval capabilities with more robust and configurable options
- [ ] Expanding test coverage to ensure reliability and catch edge cases
diff --git a/images/arxiv-screenshot.png b/images/arxiv-screenshot.png
new file mode 100644
index 0000000000000000000000000000000000000000..f5f59647551fde8fe3ecf175187407bda472fc08
GIT binary patch
literal 535574
zcmeFZby!s0-akwV4hX1(G$;ZN0t(V87)aO9A>G{_f+$GbaMK_lQZq1gm(mRiLx*&C
z_q*nt^PG5JpX+_j`S16;9KsHxJpFO1Uoqi8|`$R-a+zMMV4#>I1)J^~%oz{}u$
zK*ZG#oE%?yxjz-9sA*J0N$#~z$id19wPCge(ZzRPLHlNj46#CBWZGT #|HI@m?{yT?FSK{Xcg^h
zTCVENTdCLEc8e7#zUsF+T2beMbI`&J9Wh(kGCPI|D|%;XsTY7N-5IwQVSM6s~W#
z8gLMl;;X67dssYr=Jg6LRArn6(!ju^UNVW`h^FtSM(HLFlHGZCTI(wg@A>Vyba)Q&
zt7$&vd;0$H&v?dv1UeeN(5k*E1 Y{>I6}F*!Xl~&>@K 88En)7S`9EHKLzIjxdA#(ROLRYbvqd+_vY4GqZUz2nkEi8n1a2_#
zIsr{DRXj(TF^4{#sIVb8fAc97*O(<7@5D|ZzR}Z!d0%Cl*no1h%$>h*()mu!6Tpf=
z?jAL5FJd0r4nF2i7?y)PQ$R=I#h*s1ER3tU?Pzl}WyLE0!GBQq6H
z|I$0^m~FNes28HA`X!|f^%PhuM@)A*wvLR34s=Q^x|OFM=eDh%%M75cEO&nT$f4fV
zUAWext#txLj<&d&GXo5yEB8l%^Ebhaov+-Tq<666%`pX?M-v?AGDttl1N=mFCFh;G
zSMVvH14Gf+E`Oc=#C^`0xo-O55@Ckpy=o2Wwb+Tl-~9V`Xhv+EX-6VB@#b@_2%>J7
zpG0s8Q*b;f$=%Jj54H)6&ij;{{J*McX(p<7XG!JchBJ^L(;6--_^U4o_