From 4a643a8449bbaa61c0956820b221729325e1af78 Mon Sep 17 00:00:00 2001 From: Taranjeet Singh Date: Wed, 7 Aug 2024 14:20:15 -0700 Subject: [PATCH] feat: Improve readme (#1661) --- README.md | 61 ++++++++++++++++++++++++------------------------------- 1 file changed, 27 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 025f64f2..509e4162 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@

- Mem0 Logo + Mem0 - The Memory Layer for Personalized AI -

Mem0

- The Memory Layer for Personalized AI.
- Learn more »
+ Learn more + · + Join Discord

@@ -19,46 +19,39 @@ Y Combinator S24 - - Mem0 Twitter -

-# Mem0: The Memory Layer for Personalized AI +# Introduction -[Mem0](https://mem0.ai) enhances AI agents and Large Language Models (LLMs) with an intelligent memory layer. By retaining and utilizing contextual information, Mem0 enables more personalized and effective AI interactions across various applications. Whether you're building customer support chatbots, AI assistants, or autonomous systems, Mem0 helps your AI remember user preferences, adapt to individual needs, and continuously improve over time. +* [Mem0](https://mem0.ai) enhances AI assistants and agents with an intelligent memory layer, enabling personalized AI interactions. + +* Mem0 remembers user preferences, adapts to individual needs, and continuously improves over time, making it ideal for customer support chatbots, AI assistants, and autonomous systems. Use cases enabled by Mem0 include: -- **AI Assistants and agents**: Seamless conversations with a touch of déjà vu – just like this one - +- **AI Assistants and agents**: Seamless conversations with a touch of déjà vu - **Personalized Learning**: Tailored content recommendations and progress tracking - - **Customer Support**: Context-aware assistance with user preference memory - - **Healthcare**: Patient history and treatment plan management - - **Virtual Companions**: Deeper user relationships through conversation memory - - **Productivity**: Streamlined workflows based on user habits and task history - - **Gaming**: Adaptive environments reflecting player choices and progress ## Get Started -The simplest way to set up Mem0 is to create a managed deployment with Mem0 Platform. The platform is a hosted solution and offers a hassle-free experience with automatic updates, advanced analytics, and dedicated support. [Sign up](https://app.mem0.ai/) for Mem0 Platform to get started. +The easiest way to set up Mem0 is through the managed [Mem0 Platform](https://app.mem0.ai). This hosted solution offers automatic updates, advanced analytics, and dedicated support. [Sign up](https://app.mem0.ai) to get started. -If you prefer to install and manage Mem0 yourself, you can use the open-source Mem0 package. Read the [Installation instructions](#install) below to get started with Mem0 on your machine. +If you prefer to self-host, use the open-source Mem0 package. Follow the [installation instructions](#install) to get started. ## Installation Instructions -The Mem0 package can be installed directly from pip command in the terminal. +Install the Mem0 package via pip: ```bash pip install mem0ai ``` -Alternatively, you can use Mem0 in one click using the hosted platform [here](https://app.mem0.ai/). +Alternatively, you can use Mem0 with one click on the hosted platform [here](https://app.mem0.ai/). ### Basic Usage @@ -70,7 +63,7 @@ import os os.environ["OPENAI_API_KEY"] = "sk-xxx" ``` -Now, you can simply initialize the memory. +Now, you can initialize the memory: ```python from mem0 import Memory @@ -78,12 +71,13 @@ from mem0 import Memory m = Memory() ``` -You can perform the following task on the memory. -1. Add: adds memory -2. Update: update memory of a given memory_id -3. Search: fetch memories based on a query -4. Get: return memories for a certain user/agent/session -5. History: describes how a memory has changed over time for a specific memory ID +You can perform the following task on the memory: + +1. Add: Store a memory from any unstructured text +2. Update: Update memory of a given memory_id +3. Search: Fetch memories based on a query +4. Get: Return memories for a certain user/agent/session +5. History: Describe how a memory has changed over time for a specific memory ID ```python # 1. Add: Store a memory from any unstructured text @@ -122,7 +116,8 @@ history = m.history(memory_id=) ``` > [!TIP] -> If you are looking for a hosted version and don't want to setup the infrastucture yourself, checkout [Mem0 Platform](https://app.mem0.ai/) to get started in minutes. +> If you prefer a hosted version without the need to set up infrastructure yourself, check out the [Mem0 Platform](https://app.mem0.ai/) to get started in minutes. + ## Core Features @@ -134,7 +129,7 @@ history = m.history(memory_id=) ## Documentation -For detailed usage instructions and API reference, visit our documentation at [docs.mem0.ai](https://docs.mem0.ai). +For detailed usage instructions and API reference, visit our documentation at [docs.mem0.ai](https://docs.mem0.ai). Here, you can find more information on both the open-source version and the hosted [Mem0 Platform](https://app.mem0.ai). ## Advanced Usage @@ -168,8 +163,8 @@ m = Memory.from_config(config) [![Star History Chart](https://api.star-history.com/svg?repos=mem0ai/mem0&type=Date)](https://star-history.com/#mem0ai/mem0&Date) ## Support -Join our Slack or Discord community for support and discussions. -If you have any questions, feel free to reach out to us using one of the following methods: + +Join our community for support and discussions. If you have any questions, feel free to reach out to us using one of the following methods: - [Join our Discord](https://mem0.ai/discord) - [Join our Slack](https://mem0.ai/slack) @@ -179,9 +174,7 @@ If you have any questions, feel free to reach out to us using one of the followi ## Contributors -Join our [Discord community](https://mem0.ai/discord) to learn about memory management for AI agents and LLMs, and connect with Mem0 users and contributors. - -Share your ideas, questions, or feedback in our [GitHub Issues](https://github.com/mem0ai/mem0/issues). +Join our [Discord community](https://mem0.ai/discord) to learn about memory management for AI agents and LLMs, and connect with Mem0 users and contributors. Share your ideas, questions, or feedback in our [GitHub Issues](https://github.com/mem0ai/mem0/issues). We value and appreciate the contributions of our community. Special thanks to our contributors for helping us improve Mem0.