Memor: A Python Library for Managing and Transferring Conversational Memory Across LLMs
Project description
Overview
Memor is a library designed to help users manage the memory of their interactions with Large Language Models (LLMs). It enables users to seamlessly access and utilize the history of their conversations when prompting LLMs. That would create a more personalized and context-aware experience. Memor stands out by allowing users to transfer conversational history across different LLMs, eliminating cold starts where models don't have information about user and their preferences. Users can select specific parts of past interactions with one LLM and share them with another. By bridging the gap between isolated LLM instances, Memor revolutionizes the way users interact with AI by making transitions between models smoother.
| PyPI Counter |
|
| Github Stars |
|
| Branch | main | dev |
| CI |
|
|
| Code Quality |
Installation
PyPI
- Check Python Packaging User Guide
- Run
pip install memor==0.6
Source code
- Download Version 0.6 or Latest Source
- Run
pip install .
Usage
Define your prompt and the response(s) to that; Memor will wrap it into a object with a templated representation. You can create a session by combining multiple prompts and responses, gradually building it up:
>>> from memor import Session, Prompt, Response, Role
>>> from memor import PresetPromptTemplate, RenderFormat, LLMModel
>>> response = Response(message="I am fine.", model=LLMModel.GPT_4, role=Role.ASSISTANT, temperature=0.9, score=0.9)
>>> prompt = Prompt(message="Hello, how are you?",
responses=[response],
role=Role.USER,
template=PresetPromptTemplate.INSTRUCTION1.PROMPT_RESPONSE_STANDARD)
>>> system_prompt = Prompt(message="You are a friendly and informative AI assistant designed to answer questions on a wide range of topics.",
role=Role.SYSTEM)
>>> session = Session(messages=[system_prompt, prompt])
>>> session.render(RenderFormat.OPENAI)
The rendered output will be a list of messages formatted for compatibility with the OpenAI API.
[{"content": "You are a friendly and informative AI assistant designed to answer questions on a wide range of topics.", "role": "system"},
{"content": "I'm providing you with a history of a previous conversation. Please consider this context when responding to my new question.\n"
"Prompt: Hello, how are you?\n"
"Response: I am fine.",
"role": "user"}]
Prompt Templates
Preset Templates
Memor provides a variety of pre-defined prompt templates to control how prompts and responses are rendered. Each template is prefixed by an optional instruction string and includes variations for different formatting styles. Following are different variants of parameters:
| Instruction Name | Description |
|---|---|
INSTRUCTION1 |
"I'm providing you with a history of a previous conversation. Please consider this context when responding to my new question." |
INSTRUCTION2 |
"Here is the context from a prior conversation. Please learn from this information and use it to provide a thoughtful and context-aware response to my next questions." |
INSTRUCTION3 |
"I am sharing a record of a previous discussion. Use this information to provide a consistent and relevant answer to my next query." |
| Template Title | Description |
|---|---|
PROMPT |
Only includes the prompt message. |
RESPONSE |
Only includes the response message. |
RESPONSE0 to RESPONSE3 |
Include specific responses from a list of multiple responses. |
PROMPT_WITH_LABEL |
Prompt with a "Prompt: " prefix. |
RESPONSE_WITH_LABEL |
Response with a "Response: " prefix. |
RESPONSE0_WITH_LABEL to RESPONSE3_WITH_LABEL |
Labeled response for the i-th response. |
PROMPT_RESPONSE_STANDARD |
Includes both labeled prompt and response on a single line. |
PROMPT_RESPONSE_FULL |
A detailed multi-line representation including role, date, model, etc. |
You can access them like this:
>>> from memor import PresetPromptTemplate
>>> template = PresetPromptTemplate.INSTRUCTION1.PROMPT_RESPONSE_STANDARD
Custom Templates
You can define custom templates for your prompts using the PromptTemplate class. This class provides two key parameters that control its functionality:
content: A string that defines the template structure, following Python string formatting conventions. You can include dynamic fields using placeholders like{field_name}, which will be automatically populated using attributes from the prompt object. Some common examples of auto-filled fields are shown below:
| Prompt Object Attribute | Placeholder Syntax | Description |
|---|---|---|
prompt.message |
{prompt[message]} |
The main prompt message |
prompt.selected_response |
{prompt[response]} |
The selected response for the prompt |
prompt.date_modified |
{prompt[date_modified]} |
Timestamp of the last modification |
prompt.responses[2].message |
{responses[2][message]} |
Message from the response at index 2 |
prompt.responses[0].inference_time |
{responses[0][inference_time]} |
Inference time for the response at index 0 |
custom_map: In addition to the attributes listed above, you can define and insert custom placeholders (e.g.,{field_name}) and provide their values through a dictionary. When rendering the template, each placeholder will be replaced with its corresponding value fromcustom_map.
Suppose you want to prepend an instruction to every prompt message. You can define and use a template as follows:
>>> template = PromptTemplate(content="{instruction}, {prompt[message]}", custom_map={"instruction": "Hi"})
>>> prompt = Prompt(message="How are you?", template=template)
>>> prompt.render()
Hi, How are you?
By using this dynamic structure, you can create flexible and sophisticated prompt templates with Memor. You can design specific schemas for your conversational or instructional formats when interacting with LLM.
Issues & bug reports
Just fill an issue and describe it. We'll check it ASAP! or send an email to memor@openscilab.com.
- Please complete the issue template
You can also join our discord server
Show your support
Star this repo
Give a ⭐️ if this project helped you!
Donate to our project
If you do like our project and we hope that you do, can you please support us? Our project is not and is never going to be working for profit. We need the money just so we can continue doing what we do ;-) .
Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
Unreleased
0.6 - 2025-05-05
Added
ResponseclassidpropertyPromptclassidpropertyResponseclassregenerate_idmethodPromptclassregenerate_idmethodSessionclassrender_countermethodSessionclassremove_message_by_indexandremove_message_by_idmethodsSessionclassget_message_by_index,get_message_by_idandget_messagemethodsLLMModelenumAI_STUDIOrender format
Changed
- Test system modified
- Modification handling centralized via
_mark_modifiedmethod Sessionclassremove_messagemethod modified
0.5 - 2025-04-16
Added
Sessionclasscheck_rendermethodSessionclassclear_messagesmethodPromptclasscheck_rendermethodSessionclassestimate_tokensmethodPromptclassestimate_tokensmethodResponseclassestimate_tokensmethoduniversal_tokens_estimatorfunctionopenai_tokens_estimator_gpt_3_5functionopenai_tokens_estimator_gpt_4function
Changed
init_checkparameter added toPromptclassinit_checkparameter added toSessionclass- Test system modified
Python 3.6support droppedREADME.mdupdated
0.4 - 2025-03-17
Added
Sessionclass__contains__methodSessionclass__getitem__methodSessionclassmask_messagemethodSessionclassunmask_messagemethodSessionclassmasksattributeResponseclass__len__methodPromptclass__len__method
Changed
inference_timeparameter added toResponseclassREADME.mdupdated- Test system modified
- Python typing features added to all modules
Promptclass default values updatedResponseclass default values updated
0.3 - 2025-03-08
Added
Sessionclass__len__methodSessionclass__iter__methodSessionclass__add__and__radd__methods
Changed
tokensparameter added toPromptclasstokensparameter added toResponseclasstokensparameter added to preset templatesPromptclass modifiedResponseclass modifiedPromptTemplateclass modified
0.2 - 2025-03-01
Added
Sessionclass
Changed
Promptclass modifiedResponseclass modifiedPromptTemplateclass modifiedREADME.mdupdated- Test system modified
0.1 - 2025-02-12
Added
PromptclassResponseclassPromptTemplateclassPresetPromptTemplateclass
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file memor-0.6.tar.gz.
File metadata
- Download URL: memor-0.6.tar.gz
- Upload date:
- Size: 33.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0294a96b6eb3617224da4e161b93d96193fe1cf76649d2f8410639a051d5aa29
|
|
| MD5 |
b020acb9916bd21cf707b7b8839c5160
|
|
| BLAKE2b-256 |
87b8f53241e5bd01f9f6f4d045fbad83b68cd0da16a5669da18e76a770beba02
|
File details
Details for the file memor-0.6-py3-none-any.whl.
File metadata
- Download URL: memor-0.6-py3-none-any.whl
- Upload date:
- Size: 28.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
761e7592bff212dbb1f1e5591aa1bed3ca7bde135c2a60be8e9d17f01ce82a21
|
|
| MD5 |
c0b3a0f4d309c1c6c4af7c4a12d3cc8d
|
|
| BLAKE2b-256 |
c0f32d03b864daae3449e797fa7349290bef56f3deb5e16929efd76c9f553fb9
|