docs: update docstrings (#565)

embedchain/config/apps/AppConfig.py

@@ -13,15 +13,23 @@ class AppConfig(BaseAppConfig):
 
     def __init__(
         self,
-        log_level=None,
-        id=None,
+        log_level: str = "WARNING",
+        id: Optional[str] = None,
         collect_metrics: Optional[bool] = None,
         collection_name: Optional[str] = None,
     ):
         """
-        :param log_level: Optional. (String) Debug level
-        ['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'].
-        :param id: Optional. ID of the app. Document metadata will have this id.
-        :param collect_metrics: Defaults to True. Send anonymous telemetry to improve embedchain.
+        Initializes a configuration class instance for an App. This is the simplest form of an embedchain app.
+        Most of the configuration is done in the `App` class itself.
+
+        :param log_level: Debug level ['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'], defaults to "WARNING"
+        :type log_level: str, optional
+        :param id: ID of the app. Document metadata will have this id., defaults to None
+        :type id: Optional[str], optional
+        :param collect_metrics: Send anonymous telemetry to improve embedchain, defaults to True
+        :type collect_metrics: Optional[bool], optional
+        :param collection_name: Default collection name. It's recommended to use app.db.set_collection_name() instead,
+        defaults to None
+        :type collection_name: Optional[str], optional
         """
         super().__init__(log_level=log_level, id=id, collect_metrics=collect_metrics, collection_name=collection_name)

embedchain/config/apps/BaseAppConfig.py

@@ -13,23 +13,28 @@ class BaseAppConfig(BaseConfig, JSONSerializable):
 
     def __init__(
         self,
-        log_level=None,
+        log_level: str = "WARNING",
         db: Optional[BaseVectorDB] = None,
-        id=None,
+        id: Optional[str] = None,
         collect_metrics: bool = True,
         collection_name: Optional[str] = None,
     ):
         """
-        :param log_level: Optional. (String) Debug level
-        ['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'].
-        :param db: Optional. (Vector) database instance to use for embeddings. Deprecated in favor of app(..., db).
-        :param id: Optional. ID of the app. Document metadata will have this id.
-        :param collect_metrics: Defaults to True. Send anonymous telemetry to improve embedchain.
-        :param db_type: Optional. Initializes a default vector database of the given type.
-        Using the `db` argument is preferred.
-        :param es_config: Optional. elasticsearch database config to be used for connection
-        :param collection_name: Optional. Default collection name.
-        It's recommended to use app.set_collection_name() instead.
+        Initializes a configuration class instance for an App.
+        Most of the configuration is done in the `App` class itself.
+
+        :param log_level: Debug level ['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'], defaults to "WARNING"
+        :type log_level: str, optional
+        :param db: A database class. It is recommended to set this directly in the `App` class, not this config,
+        defaults to None
+        :type db: Optional[BaseVectorDB], optional
+        :param id: ID of the app. Document metadata will have this id., defaults to None
+        :type id: Optional[str], optional
+        :param collect_metrics: Send anonymous telemetry to improve embedchain, defaults to True
+        :type collect_metrics: Optional[bool], optional
+        :param collection_name: Default collection name. It's recommended to use app.db.set_collection_name() instead,
+        defaults to None
+        :type collection_name: Optional[str], optional
         """
         self._setup_logging(log_level)
         self.id = id

embedchain/config/apps/CustomAppConfig.py

@@ -3,6 +3,7 @@ from typing import Optional
 from dotenv import load_dotenv
 
 from embedchain.helper_classes.json_serializable import register_deserializable
+from embedchain.vectordb.base_vector_db import BaseVectorDB
 
 from .BaseAppConfig import BaseAppConfig
 
@@ -17,24 +18,29 @@ class CustomAppConfig(BaseAppConfig):
 
     def __init__(
         self,
-        log_level=None,
-        db=None,
-        id=None,
+        log_level: str = "WARNING",
+        db: Optional[BaseVectorDB] = None,
+        id: Optional[str] = None,
         collect_metrics: Optional[bool] = None,
         collection_name: Optional[str] = None,
     ):
         """
-        :param log_level: Optional. (String) Debug level
-        ['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'].
-        :param db: Optional. (Vector) database to use for embeddings.
-        :param id: Optional. ID of the app. Document metadata will have this id.
-        :param provider: Optional. (Providers): LLM Provider to use.
-        :param open_source_app_config: Optional. Config instance needed for open source apps.
-        :param collect_metrics: Defaults to True. Send anonymous telemetry to improve embedchain.
-        :param collection_name: Optional. Default collection name.
-        It's recommended to use app.set_collection_name() instead.
-        """
+        Initializes a configuration class instance for an Custom App.
+        Most of the configuration is done in the `CustomApp` class itself.
 
+        :param log_level: Debug level ['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'], defaults to "WARNING"
+        :type log_level: str, optional
+        :param db: A database class. It is recommended to set this directly in the `CustomApp` class, not this config,
+        defaults to None
+        :type db: Optional[BaseVectorDB], optional
+        :param id: ID of the app. Document metadata will have this id., defaults to None
+        :type id: Optional[str], optional
+        :param collect_metrics: Send anonymous telemetry to improve embedchain, defaults to True
+        :type collect_metrics: Optional[bool], optional
+        :param collection_name: Default collection name. It's recommended to use app.db.set_collection_name() instead,
+        defaults to None
+        :type collection_name: Optional[str], optional
+        """
         super().__init__(
             log_level=log_level, db=db, id=id, collect_metrics=collect_metrics, collection_name=collection_name
         )

embedchain/config/apps/OpenSourceAppConfig.py

@@ -13,21 +13,27 @@ class OpenSourceAppConfig(BaseAppConfig):
 
     def __init__(
         self,
-        log_level=None,
-        id=None,
+        log_level: str = "WARNING",
+        id: Optional[str] = None,
         collect_metrics: Optional[bool] = None,
-        model=None,
+        model: str = "orca-mini-3b.ggmlv3.q4_0.bin",
         collection_name: Optional[str] = None,
     ):
         """
-        :param log_level: Optional. (String) Debug level
-        ['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'].
-        :param id: Optional. ID of the app. Document metadata will have this id.
-        :param collect_metrics: Defaults to True. Send anonymous telemetry to improve embedchain.
-        :param model: Optional. GPT4ALL uses the model to instantiate the class.
-        So unlike `App`, it has to be provided before querying.
-        :param collection_name: Optional. Default collection name.
-        It's recommended to use app.db.set_collection_name() instead.
+        Initializes a configuration class instance for an Open Source App.
+
+        :param log_level: Debug level ['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'], defaults to "WARNING"
+        :type log_level: str, optional
+        :param id: ID of the app. Document metadata will have this id., defaults to None
+        :type id: Optional[str], optional
+        :param collect_metrics: Send anonymous telemetry to improve embedchain, defaults to True
+        :type collect_metrics: Optional[bool], optional
+        :param model: GPT4ALL uses the model to instantiate the class.
+        Unlike `App`, it has to be provided before querying, defaults to "orca-mini-3b.ggmlv3.q4_0.bin"
+        :type model: str, optional
+        :param collection_name: Default collection name. It's recommended to use app.db.set_collection_name() instead,
+        defaults to None
+        :type collection_name: Optional[str], optional
         """
         self.model = model or "orca-mini-3b.ggmlv3.q4_0.bin"