1.0.0 • Published 4 months ago
episodic-llm-mem v1.0.0
Library Title: episodic-mem-js (or your chosen name)
Description: A brief description of what the library does (episodic vector memory, long context, etc.).
Installation Instructions:
Installation
npm install episodic-mem-js
Use code with caution.
Markdown
Use code with caution.
Usage Examples: Provide clear and concise code examples to show how to use the EpisodicVectorMemory class. Include examples for:
Importing the library.
Creating an instance of EpisodicVectorMemory.
Adding vectors (with and without text/metadata).
Querying vectors.
Saving and loading memory.
Here's an example usage section in README.md:
## Usage
```javascript
const EpisodicVectorMemory = require('episodic-mem-js');
const memory = new EpisodicVectorMemory();
memory.add([1, 0, 0], "Document 1", { source: "file1.txt" });
memory.add([0, 1, 0], "Document 2", { source: "file2.pdf" });
const queryVector = [0.9, 0.1, 0];
const results = memory.query(queryVector, 1);
console.log("Query Results:", results); // Output the results
// Saving and Loading
memory.save('my_memory.json');
const loadedMemory = new EpisodicVectorMemory();
loadedMemory.load('my_memory.json');
console.log("Loaded Memory Query:", loadedMemory.query(queryVector, 1));
Use code with caution.
Markdown
Constructor Options: Explain the constructor parameters (eventTimeThreshold, temporalContextWindow) and what they control.
### Constructor Options
```javascript
const memory = new EpisodicVectorMemory({
eventTimeThreshold: 600000, // 10 minutes in milliseconds
temporalContextWindow: 3 // Retrieve +/- 3 events
});
Use code with caution.
Markdown
eventTimeThreshold (milliseconds): Time threshold to start a new episodic event. Default is 300000 ms (5 minutes).
temporalContextWindow (integer): Number of temporally adjacent events to retrieve around similar events during a query. Default is 2.
API Documentation (Optional but good): You can list the methods (add, query, save, load) and briefly describe their parameters and return values.
Further Customization: Mention any potential customizations (like different segmentation methods if you implemented any, or plans for future features).
License Information: MIT License
1.0.0
4 months ago