diff --git a/doc/personal_memory/personal_memory.md b/doc/personal_memory/personal_memory.md index 0b644ea7..1d2ac226 100644 --- a/doc/personal_memory/personal_memory.md +++ b/doc/personal_memory/personal_memory.md @@ -1,8 +1,8 @@ -# Personal Memory in reme +# Personal Memory in Reme ## Configuration Logic -reme's personal memory system consists of two main components: retrieval and summarization. The configuration for these components is defined in the default.yaml file. +Reme's personal memory system consists of two main components: retrieval and summarization. The configuration for these components is defined in the default.yaml file. ### Retrieval Configuration (`retrieve_personal_memory`) @@ -121,4 +121,4 @@ for query in queries: ## Complete Example -For a complete working example, refer to `/cookbook/simple_demo/use_personal_memory_demo.py` in the reme repository. \ No newline at end of file +For a complete working example, refer to `/cookbook/simple_demo/use_personal_memory_demo.py` in the Reme repository. \ No newline at end of file diff --git a/doc/personal_memory/personal_retrieve_ops.md b/doc/personal_memory/personal_retrieve_ops.md index 01307e6f..dc2c7b5e 100644 --- a/doc/personal_memory/personal_retrieve_ops.md +++ b/doc/personal_memory/personal_retrieve_ops.md @@ -1,11 +1,4 @@ -# Personal Memory Retrieve Operations - -This document describes the operations used in the personal memory retrieval flow of MemoryScope. The retrieval flow is defined in the configuration as: - -```yaml -retrieve_personal_memory: - flow_content: set_query_op >> (extract_time_op | (retrieve_memory_op >> semantic_rank_op)) >> fuse_rerank_op -``` +# Personal Memory Retrieve Ops ## SetQueryOp @@ -137,16 +130,3 @@ The operation: 3. Flattens the messages into a single list 4. Sorts messages by creation time if available 5. Stores the filtered messages back in the context - -## Complete Flow Execution - -When the personal memory retrieval flow executes: - -1. `SetQueryOp` prepares the query with timestamp -2. Two parallel paths execute: - - `ExtractTimeOp` extracts time information from the query - - `RetrieveMemoryOp` followed by `SemanticRankOp` retrieves and ranks memories -3. `FuseRerankOp` combines the results, considering both semantic relevance and time information -4. The final output is a ranked list of memories relevant to the query - -This flow provides a sophisticated memory retrieval system that considers semantic relevance, memory types, and temporal context to deliver the most appropriate memories for a given query. \ No newline at end of file diff --git a/doc/personal_memory/personal_summary_ops.md b/doc/personal_memory/personal_summary_ops.md index d7ea2584..3b62f458 100644 --- a/doc/personal_memory/personal_summary_ops.md +++ b/doc/personal_memory/personal_summary_ops.md @@ -1,17 +1,4 @@ -# Personal Memory Summary Operations - -This document provides a detailed overview of the operations (ops) used in the personal memory summarization flow in MemoryScope. Each operation plays a specific role in processing, filtering, and storing personal memories. - -## Overview - -As defined in the configuration, the personal memory summarization flow follows this sequence: - -```yaml -summary_personal_memory: - flow_content: info_filter_op >> (get_observation_op | get_observation_with_time_op | load_today_memory_op) >> contra_repeat_op >> update_vector_store_op -``` - -This document describes each operation in detail, including its purpose, parameters, and configuration options. +# Personal Memory Summary Ops ## InfoFilterOp @@ -156,41 +143,3 @@ This operation is the final step in the personal memory summarization flow. It: 3. Records the number of deleted and inserted memories This ensures that the vector store remains up-to-date with the latest processed memories. - -## Configuration Example - -Here's an example of how to configure these operations in your YAML configuration: - -```yaml -op: - info_filter_op: - params: - preserved_scores: "2,3" - info_filter_msg_max_size: 200 - - load_today_memory_op: - params: - top_k: 50 - - contra_repeat_op: - params: - contra_repeat_max_count: 50 - enable_contra_repeat: true - - long_contra_repeat_op: - params: - long_contra_repeat_max_count: 50 - enable_long_contra_repeat: true - - update_insight_op: - params: - update_insight_threshold: 0.3 - update_insight_max_count: 5 - - get_reflection_subject_op: - params: - reflect_obs_cnt_threshold: 10 - reflect_num_questions: 3 -``` - -This configuration can be adjusted based on your specific requirements for personal memory processing.