Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

revised README #359

Closed
wants to merge 1 commit into from
Closed

revised README #359

wants to merge 1 commit into from

Conversation

danielchalef
Copy link
Member

@danielchalef danielchalef commented Sep 23, 2024

Important

Update README.md to reflect Zep's rebranding, new features, and differences between Community Edition and Open Source.

  • Rebranding:
    • Updated title to "Zep: The Memory Foundation For Your AI Stack".
    • Updated subtitle to "Build AI agents that continually learn. Power personalized experiences."
  • Documentation Links:
    • Updated links to Quick Start, Documentation, and Zep Cloud Docs.
  • Product Description:
    • Describes Zep's use of a temporal Knowledge Graph for memory management.
    • Lists supported features like chat history, JSON ingestion, and group-level graphs.
  • API and SDKs:
    • Provides examples for Python, TypeScript, and Go SDKs.
    • Describes high-level and lower-level API capabilities.
  • Zep Community Edition vs Zep Open Source:
    • Highlights differences, including deprecated web UI and expanded SDK support.
    • Notes lack of migration path from Zep OSS to Zep CE.
  • Contributing:
    • Encourages contributions and refers to the CONTRIBUTING.md file.

This description was created by Ellipsis for b8364bb. It will automatically update as commits are pushed.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good to me! Reviewed everything up to b8364bb in 12 seconds

More details
  • Looked at 278 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. README.md:67
  • Draft comment:
    Typo: 'buiilding' should be 'building'.
Knowledge Graphs allow us to model an agent's complex world and offer a superior approach to retrieval than semantic search alone, which is commonly used in RAG. Most approaches to building Knowledge Graphs don't reason well with state changes. Facts inevitably change over time as users provide new information or business data changes.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The README has a typo in line 67 where 'buiilding' should be 'building'.

Workflow ID: wflow_zCElXSF4kREfweT5


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@danielchalef danielchalef deleted the chore/readme-ce branch September 25, 2024 15:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants