Added comments to the base classes

code/modules/chat_processor/base.py

@@ -1,6 +1,12 @@
+# Template for chat processor classes
+
+
 class ChatProcessorBase:
     def __init__(self, config):
         self.config = config
 
     def process(self, message):
+        """
+        Processes and Logs the message
+        """
         raise NotImplementedError("process method not implemented")

code/modules/retriever/base.py

@@ -1,6 +1,12 @@
+# template for retriever classes
+
+
 class BaseRetriever:
     def __init__(self, config):
         self.config = config
 
     def return_retriever(self):
+        """
+        Returns the retriever object
+        """
         raise NotImplementedError

code/modules/vectorstore/base.py

@@ -1,17 +1,32 @@
+# template for vector store classes
+
+
 class VectorStoreBase:
     def __init__(self, config):
         self.config = config
 
     def _init_vector_db(self):
+        """
+        Creates a vector store object
+        """
         raise NotImplementedError
 
-    def create_database(self, database_name):
+    def create_database(self):
+        """
+        Populates the vector store with documents
+        """
         raise NotImplementedError
 
-    def load_database(self, database_name):
+    def load_database(self):
+        """
+        Loads the vector store from disk
+        """
         raise NotImplementedError
 
     def as_retriever(self):
+        """
+        Returns the vector store as a retriever
+        """
         raise NotImplementedError
 
     def __str__(self):