[chore]: Rename modules for better readability and maintainability (#587)

Author: deshraj

docs/advanced/app_types.mdx

@@ -71,10 +71,10 @@ app = OpenSourceApp()
 from embedchain import CustomApp
 from embedchain.config import (CustomAppConfig, ElasticsearchDBConfig,
                                EmbedderConfig, LlmConfig)
-from embedchain.embedder.vertexai_embedder import VertexAiEmbedder
-from embedchain.llm.vertex_ai_llm import VertexAiLlm
+from embedchain.embedder.vertexai import VertexAiEmbedder
+from embedchain.llm.vertex_ai import VertexAiLlm
 from embedchain.models import EmbeddingFunctions, Providers
-from embedchain.vectordb.elasticsearch_db import Elasticsearch
+from embedchain.vectordb.elasticsearch import Elasticsearch
 
 # short
 app = CustomApp(llm=VertexAiLlm(), db=Elasticsearch(), embedder=VertexAiEmbedder())

embedchain/__init__.py

@@ -6,5 +6,6 @@
 from embedchain.apps.CustomApp import CustomApp  # noqa: F401
 from embedchain.apps.Llama2App import Llama2App  # noqa: F401
 from embedchain.apps.OpenSourceApp import OpenSourceApp  # noqa: F401
-from embedchain.apps.PersonApp import PersonApp, PersonOpenSourceApp  # noqa: F401
-from embedchain.vectordb.chroma_db import ChromaDB  # noqa: F401
+from embedchain.apps.PersonApp import (PersonApp,  # noqa: F401
+                                       PersonOpenSourceApp)
+from embedchain.vectordb.chroma import ChromaDB  # noqa: F401

embedchain/apps/App.py

@@ -3,10 +3,10 @@
 from embedchain.config import (AppConfig, BaseEmbedderConfig, BaseLlmConfig,
                                ChromaDbConfig)
 from embedchain.embedchain import EmbedChain
-from embedchain.embedder.openai_embedder import OpenAiEmbedder
-from embedchain.helper_classes.json_serializable import register_deserializable
-from embedchain.llm.openai_llm import OpenAiLlm
-from embedchain.vectordb.chroma_db import ChromaDB
+from embedchain.embedder.openai import OpenAiEmbedder
+from embedchain.helper.json_serializable import register_deserializable
+from embedchain.llm.openai import OpenAILlm
+from embedchain.vectordb.chroma import ChromaDB
 
 
 @register_deserializable
@@ -47,7 +47,7 @@ def __init__(
         if config is None:
             config = AppConfig()
 
-        llm = OpenAiLlm(config=llm_config)
+        llm = OpenAILlm(config=llm_config)
         embedder = OpenAiEmbedder(config=BaseEmbedderConfig(model="text-embedding-ada-002"))
         database = ChromaDB(config=chromadb_config)
 

embedchain/apps/CustomApp.py

@@ -2,10 +2,10 @@
 
 from embedchain.config import CustomAppConfig
 from embedchain.embedchain import EmbedChain
-from embedchain.embedder.base_embedder import BaseEmbedder
-from embedchain.helper_classes.json_serializable import register_deserializable
-from embedchain.llm.base_llm import BaseLlm
-from embedchain.vectordb.base_vector_db import BaseVectorDB
+from embedchain.embedder.base import BaseEmbedder
+from embedchain.helper.json_serializable import register_deserializable
+from embedchain.llm.base import BaseLlm
+from embedchain.vectordb.base import BaseVectorDB
 
 
 @register_deserializable
@@ -35,7 +35,7 @@ def __init__(
         :param config: Config for the app instance. This is the most basic configuration,
         that does not fall into the LLM, database or embedder category, defaults to None
         :type config: Optional[CustomAppConfig], optional
-        :param llm: LLM Class instance. example: `from embedchain.llm.openai_llm import OpenAiLlm`, defaults to None
+        :param llm: LLM Class instance. example: `from embedchain.llm.openai import OpenAILlm`, defaults to None
         :type llm: BaseLlm
         :param db: The database to use for storing and retrieving embeddings,
         example: `from embedchain.vectordb.chroma_db import ChromaDb`, defaults to None

embedchain/apps/Llama2App.py

@@ -2,10 +2,10 @@
 
 from embedchain.apps.CustomApp import CustomApp
 from embedchain.config import CustomAppConfig
-from embedchain.embedder.openai_embedder import OpenAiEmbedder
-from embedchain.helper_classes.json_serializable import register_deserializable
-from embedchain.llm.llama2_llm import Llama2Llm
-from embedchain.vectordb.chroma_db import ChromaDB
+from embedchain.embedder.openai import OpenAiEmbedder
+from embedchain.helper.json_serializable import register_deserializable
+from embedchain.llm.llama2 import Llama2Llm
+from embedchain.vectordb.chroma import ChromaDB
 
 
 @register_deserializable

embedchain/apps/OpenSourceApp.py

@@ -4,10 +4,10 @@
 from embedchain.config import (BaseEmbedderConfig, BaseLlmConfig,
                                ChromaDbConfig, OpenSourceAppConfig)
 from embedchain.embedchain import EmbedChain
-from embedchain.embedder.gpt4all_embedder import GPT4AllEmbedder
-from embedchain.helper_classes.json_serializable import register_deserializable
-from embedchain.llm.gpt4all_llm import GPT4ALLLlm
-from embedchain.vectordb.chroma_db import ChromaDB
+from embedchain.embedder.gpt4all import GPT4AllEmbedder
+from embedchain.helper.json_serializable import register_deserializable
+from embedchain.llm.gpt4all import GPT4ALLLlm
+from embedchain.vectordb.chroma import ChromaDB
 
 gpt4all_model = None
 

embedchain/apps/PersonApp.py

@@ -6,7 +6,7 @@
 from embedchain.config.apps.BaseAppConfig import BaseAppConfig
 from embedchain.config.llm.base_llm_config import (DEFAULT_PROMPT,
                                                    DEFAULT_PROMPT_WITH_HISTORY)
-from embedchain.helper_classes.json_serializable import register_deserializable
+from embedchain.helper.json_serializable import register_deserializable
 
 
 @register_deserializable

embedchain/bots/base.py

@@ -2,17 +2,17 @@
 
 from embedchain import CustomApp
 from embedchain.config import AddConfig, CustomAppConfig, LlmConfig
-from embedchain.embedder.openai_embedder import OpenAiEmbedder
-from embedchain.helper_classes.json_serializable import (
-    JSONSerializable, register_deserializable)
-from embedchain.llm.openai_llm import OpenAiLlm
-from embedchain.vectordb.chroma_db import ChromaDB
+from embedchain.embedder.openai import OpenAiEmbedder
+from embedchain.helper.json_serializable import (JSONSerializable,
+                                                 register_deserializable)
+from embedchain.llm.openai import OpenAILlm
+from embedchain.vectordb.chroma import ChromaDB
 
 
 @register_deserializable
 class BaseBot(JSONSerializable):
     def __init__(self):
-        self.app = CustomApp(config=CustomAppConfig(), llm=OpenAiLlm(), db=ChromaDB(), embedder=OpenAiEmbedder())
+        self.app = CustomApp(config=CustomAppConfig(), llm=OpenAILlm(), db=ChromaDB(), embedder=OpenAiEmbedder())
 
     def add(self, data: Any, config: AddConfig = None):
         """

embedchain/bots/discord.py

@@ -6,7 +6,7 @@
 from discord import app_commands
 from discord.ext import commands
 
-from embedchain.helper_classes.json_serializable import register_deserializable
+from embedchain.helper.json_serializable import register_deserializable
 
 from .base import BaseBot
 

embedchain/bots/poe.py

@@ -5,7 +5,7 @@
 
 from fastapi_poe import PoeBot, run
 
-from embedchain.helper_classes.json_serializable import register_deserializable
+from embedchain.helper.json_serializable import register_deserializable
 
 from .base import BaseBot