docs: added comments

scripts/memory/base.py

@@ -3,6 +3,7 @@ import abc
 from config import AbstractSingleton, Config
 import openai
 
+# try to import sentence transformers, if it fails, default to ada
 try:
     from sentence_transformers import SentenceTransformer
 except ImportError:
@@ -18,6 +19,7 @@ cfg = Config()
 def get_embedding(text):
     text = text.replace("\n", " ")
 
+    # use the embeder specified in the config
     if cfg.memory_embeder == "sbert":
         embedding = SentenceTransformer("sentence-transformers/all-mpnet-base-v2", device="cpu").encode(text, show_progress_bar=False)
     else:

scripts/memory/local.py

@@ -6,8 +6,10 @@ import os
 from memory.base import MemoryProviderSingleton, get_embedding
 from config import Config 
 
+# TODO: get the embeddings dimension without importing config
 cfg = Config()
 
+# set the embedding dimension based on the embeder
 EMBED_DIM = 1536 if cfg.memory_embeder == "ada" else 768
 SAVE_OPTIONS = orjson.OPT_SERIALIZE_NUMPY | orjson.OPT_SERIALIZE_DATACLASS
 

scripts/memory/pinecone.py

@@ -10,6 +10,7 @@ class PineconeMemory(MemoryProviderSingleton):
         pinecone_api_key = cfg.pinecone_api_key
         pinecone_region = cfg.pinecone_region
         pinecone.init(api_key=pinecone_api_key, environment=pinecone_region)
+        # set the embedding dimension based on the embeder
         dimension = 1536 if cfg.memory_embeder == "ada" else 768
         metric = "cosine"
         pod_type = "p1"

scripts/memory/redismem.py

@@ -11,8 +11,10 @@ from logger import logger
 from colorama import Fore, Style
 from config import Config 
 
+# TODO: get the embeddings dimension without importing config
 cfg = Config()
 
+# set the embedding dimension based on the embeder
 EMBED_DIM = 1536 if cfg.memory_embeder == "ada" else 768
 
 SCHEMA = [