From 79f5a1d0529eb288cabe92203687140b4899853d Mon Sep 17 00:00:00 2001 From: Deshraj Yadav Date: Sun, 10 Sep 2023 18:31:40 -0700 Subject: [PATCH] [chore]: Rename modules for better readability and maintainability (#587) --- docs/advanced/app_types.mdx | 6 +++--- embedchain/__init__.py | 5 +++-- embedchain/apps/App.py | 10 +++++----- embedchain/apps/CustomApp.py | 10 +++++----- embedchain/apps/Llama2App.py | 8 ++++---- embedchain/apps/OpenSourceApp.py | 8 ++++---- embedchain/apps/PersonApp.py | 2 +- embedchain/bots/base.py | 12 ++++++------ embedchain/bots/discord.py | 2 +- embedchain/bots/poe.py | 2 +- embedchain/bots/slack.py | 2 +- embedchain/bots/whatsapp.py | 2 +- embedchain/chunkers/base_chunker.py | 2 +- embedchain/chunkers/docs_site.py | 2 +- embedchain/chunkers/docx_file.py | 2 +- embedchain/chunkers/notion.py | 2 +- embedchain/chunkers/pdf_file.py | 2 +- embedchain/chunkers/qna_pair.py | 2 +- embedchain/chunkers/text.py | 2 +- embedchain/chunkers/web_page.py | 2 +- embedchain/chunkers/youtube_video.py | 2 +- embedchain/config/AddConfig.py | 2 +- embedchain/config/BaseConfig.py | 2 +- embedchain/config/apps/AppConfig.py | 2 +- embedchain/config/apps/BaseAppConfig.py | 4 ++-- embedchain/config/apps/CustomAppConfig.py | 4 ++-- embedchain/config/apps/OpenSourceAppConfig.py | 2 +- embedchain/config/embedder/BaseEmbedderConfig.py | 2 +- embedchain/config/llm/base_llm_config.py | 2 +- embedchain/config/vectordbs/ChromaDbConfig.py | 2 +- embedchain/config/vectordbs/ElasticsearchDBConfig.py | 2 +- embedchain/data_formatter/data_formatter.py | 2 +- embedchain/embedchain.py | 8 ++++---- embedchain/embedder/{base_embedder.py => base.py} | 0 .../embedder/{gpt4all_embedder.py => gpt4all.py} | 2 +- .../{huggingface_embedder.py => huggingface.py} | 2 +- .../embedder/{openai_embedder.py => openai.py} | 2 +- .../embedder/{vertexai_embedder.py => vertexai.py} | 2 +- .../{helper_classes => helper}/json_serializable.py | 0 embedchain/llm/{antrophic_llm.py => antrophic.py} | 4 ++-- .../llm/{azure_openai_llm.py => azure_openai.py} | 8 ++++---- embedchain/llm/{base_llm.py => base.py} | 2 +- embedchain/llm/{gpt4all_llm.py => gpt4all.py} | 4 ++-- embedchain/llm/{llama2_llm.py => llama2.py} | 4 ++-- embedchain/llm/{openai_llm.py => openai.py} | 6 +++--- embedchain/llm/{vertex_ai_llm.py => vertex_ai.py} | 4 ++-- embedchain/loaders/base_loader.py | 2 +- embedchain/loaders/docs_site_loader.py | 2 +- embedchain/loaders/docx_file.py | 2 +- embedchain/loaders/local_qna_pair.py | 2 +- embedchain/loaders/local_text.py | 2 +- embedchain/loaders/notion.py | 2 +- embedchain/loaders/pdf_file.py | 2 +- embedchain/loaders/sitemap.py | 2 +- embedchain/loaders/web_page.py | 2 +- embedchain/loaders/youtube_video.py | 2 +- embedchain/vectordb/{base_vector_db.py => base.py} | 4 ++-- embedchain/vectordb/{chroma_db.py => chroma.py} | 4 ++-- .../{elasticsearch_db.py => elasticsearch.py} | 4 ++-- pyproject.toml | 2 +- tests/embedchain/test_embedchain.py | 4 ++-- tests/helper_classes/test_json_serializable.py | 4 ++-- tests/llm/test_chat.py | 2 +- tests/vectordb/test_chroma_db.py | 8 ++++---- tests/vectordb/test_elasticsearch_db.py | 4 ++-- 65 files changed, 109 insertions(+), 108 deletions(-) rename embedchain/embedder/{base_embedder.py => base.py} (100%) rename embedchain/embedder/{gpt4all_embedder.py => gpt4all.py} (93%) rename embedchain/embedder/{huggingface_embedder.py => huggingface.py} (91%) rename embedchain/embedder/{openai_embedder.py => openai.py} (96%) rename embedchain/embedder/{vertexai_embedder.py => vertexai.py} (91%) rename embedchain/{helper_classes => helper}/json_serializable.py (100%) rename embedchain/llm/{antrophic_llm.py => antrophic.py} (87%) rename embedchain/llm/{azure_openai_llm.py => azure_openai.py} (83%) rename embedchain/llm/{base_llm.py => base.py} (99%) rename embedchain/llm/{gpt4all_llm.py => gpt4all.py} (92%) rename embedchain/llm/{llama2_llm.py => llama2.py} (88%) rename embedchain/llm/{openai_llm.py => openai.py} (89%) rename embedchain/llm/{vertex_ai_llm.py => vertex_ai.py} (87%) rename embedchain/vectordb/{base_vector_db.py => base.py} (94%) rename embedchain/vectordb/{chroma_db.py => chroma.py} (98%) rename embedchain/vectordb/{elasticsearch_db.py => elasticsearch.py} (95%) diff --git a/docs/advanced/app_types.mdx b/docs/advanced/app_types.mdx index 757fb058..7b094e59 100644 --- a/docs/advanced/app_types.mdx +++ b/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()) diff --git a/embedchain/__init__.py b/embedchain/__init__.py index e0891bdb..0cea3f4f 100644 --- a/embedchain/__init__.py +++ b/embedchain/__init__.py @@ -6,5 +6,6 @@ from embedchain.apps.App import App # noqa: F401 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 diff --git a/embedchain/apps/App.py b/embedchain/apps/App.py index 87602ed0..d8dc6559 100644 --- a/embedchain/apps/App.py +++ b/embedchain/apps/App.py @@ -3,10 +3,10 @@ from typing import Optional 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 @@ class App(EmbedChain): 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) diff --git a/embedchain/apps/CustomApp.py b/embedchain/apps/CustomApp.py index b8aa7d3b..875027bf 100644 --- a/embedchain/apps/CustomApp.py +++ b/embedchain/apps/CustomApp.py @@ -2,10 +2,10 @@ from typing import Optional 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 @@ class CustomApp(EmbedChain): :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 diff --git a/embedchain/apps/Llama2App.py b/embedchain/apps/Llama2App.py index a62148ba..2319f573 100644 --- a/embedchain/apps/Llama2App.py +++ b/embedchain/apps/Llama2App.py @@ -2,10 +2,10 @@ from typing import Optional 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 diff --git a/embedchain/apps/OpenSourceApp.py b/embedchain/apps/OpenSourceApp.py index f6d12673..80ece567 100644 --- a/embedchain/apps/OpenSourceApp.py +++ b/embedchain/apps/OpenSourceApp.py @@ -4,10 +4,10 @@ from typing import Optional 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 diff --git a/embedchain/apps/PersonApp.py b/embedchain/apps/PersonApp.py index de15be2d..bfc3a7ac 100644 --- a/embedchain/apps/PersonApp.py +++ b/embedchain/apps/PersonApp.py @@ -6,7 +6,7 @@ from embedchain.config import BaseLlmConfig 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 diff --git a/embedchain/bots/base.py b/embedchain/bots/base.py index 2ac81748..60b69b01 100644 --- a/embedchain/bots/base.py +++ b/embedchain/bots/base.py @@ -2,17 +2,17 @@ from typing import Any 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): """ diff --git a/embedchain/bots/discord.py b/embedchain/bots/discord.py index fd6716ec..d2984982 100644 --- a/embedchain/bots/discord.py +++ b/embedchain/bots/discord.py @@ -6,7 +6,7 @@ import discord 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 diff --git a/embedchain/bots/poe.py b/embedchain/bots/poe.py index 17938217..58e82bfb 100644 --- a/embedchain/bots/poe.py +++ b/embedchain/bots/poe.py @@ -5,7 +5,7 @@ from typing import List, Optional 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 diff --git a/embedchain/bots/slack.py b/embedchain/bots/slack.py index a00ec8b0..21834d8d 100644 --- a/embedchain/bots/slack.py +++ b/embedchain/bots/slack.py @@ -5,7 +5,7 @@ import signal import sys from embedchain import App -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable from .base import BaseBot diff --git a/embedchain/bots/whatsapp.py b/embedchain/bots/whatsapp.py index 4cdd1a94..c9193f6f 100644 --- a/embedchain/bots/whatsapp.py +++ b/embedchain/bots/whatsapp.py @@ -4,7 +4,7 @@ import logging import signal import sys -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable from .base import BaseBot diff --git a/embedchain/chunkers/base_chunker.py b/embedchain/chunkers/base_chunker.py index 2a926d3e..3787ff5b 100644 --- a/embedchain/chunkers/base_chunker.py +++ b/embedchain/chunkers/base_chunker.py @@ -1,6 +1,6 @@ import hashlib -from embedchain.helper_classes.json_serializable import JSONSerializable +from embedchain.helper.json_serializable import JSONSerializable from embedchain.models.data_type import DataType diff --git a/embedchain/chunkers/docs_site.py b/embedchain/chunkers/docs_site.py index e5ea879f..27f5b388 100644 --- a/embedchain/chunkers/docs_site.py +++ b/embedchain/chunkers/docs_site.py @@ -4,7 +4,7 @@ from langchain.text_splitter import RecursiveCharacterTextSplitter from embedchain.chunkers.base_chunker import BaseChunker from embedchain.config.AddConfig import ChunkerConfig -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable @register_deserializable diff --git a/embedchain/chunkers/docx_file.py b/embedchain/chunkers/docx_file.py index 51935d84..9fd23317 100644 --- a/embedchain/chunkers/docx_file.py +++ b/embedchain/chunkers/docx_file.py @@ -4,7 +4,7 @@ from langchain.text_splitter import RecursiveCharacterTextSplitter from embedchain.chunkers.base_chunker import BaseChunker from embedchain.config.AddConfig import ChunkerConfig -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable @register_deserializable diff --git a/embedchain/chunkers/notion.py b/embedchain/chunkers/notion.py index 5b473e0f..6edc3824 100644 --- a/embedchain/chunkers/notion.py +++ b/embedchain/chunkers/notion.py @@ -4,7 +4,7 @@ from langchain.text_splitter import RecursiveCharacterTextSplitter from embedchain.chunkers.base_chunker import BaseChunker from embedchain.config.AddConfig import ChunkerConfig -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable @register_deserializable diff --git a/embedchain/chunkers/pdf_file.py b/embedchain/chunkers/pdf_file.py index 1a482553..b89ad1f9 100644 --- a/embedchain/chunkers/pdf_file.py +++ b/embedchain/chunkers/pdf_file.py @@ -4,7 +4,7 @@ from langchain.text_splitter import RecursiveCharacterTextSplitter from embedchain.chunkers.base_chunker import BaseChunker from embedchain.config.AddConfig import ChunkerConfig -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable @register_deserializable diff --git a/embedchain/chunkers/qna_pair.py b/embedchain/chunkers/qna_pair.py index 451ac010..bc30119c 100644 --- a/embedchain/chunkers/qna_pair.py +++ b/embedchain/chunkers/qna_pair.py @@ -4,7 +4,7 @@ from langchain.text_splitter import RecursiveCharacterTextSplitter from embedchain.chunkers.base_chunker import BaseChunker from embedchain.config.AddConfig import ChunkerConfig -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable @register_deserializable diff --git a/embedchain/chunkers/text.py b/embedchain/chunkers/text.py index 0329d959..cda7c264 100644 --- a/embedchain/chunkers/text.py +++ b/embedchain/chunkers/text.py @@ -4,7 +4,7 @@ from langchain.text_splitter import RecursiveCharacterTextSplitter from embedchain.chunkers.base_chunker import BaseChunker from embedchain.config.AddConfig import ChunkerConfig -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable @register_deserializable diff --git a/embedchain/chunkers/web_page.py b/embedchain/chunkers/web_page.py index 395cf250..af1845c7 100644 --- a/embedchain/chunkers/web_page.py +++ b/embedchain/chunkers/web_page.py @@ -4,7 +4,7 @@ from langchain.text_splitter import RecursiveCharacterTextSplitter from embedchain.chunkers.base_chunker import BaseChunker from embedchain.config.AddConfig import ChunkerConfig -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable @register_deserializable diff --git a/embedchain/chunkers/youtube_video.py b/embedchain/chunkers/youtube_video.py index 41d27b0f..852bf804 100644 --- a/embedchain/chunkers/youtube_video.py +++ b/embedchain/chunkers/youtube_video.py @@ -4,7 +4,7 @@ from langchain.text_splitter import RecursiveCharacterTextSplitter from embedchain.chunkers.base_chunker import BaseChunker from embedchain.config.AddConfig import ChunkerConfig -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable @register_deserializable diff --git a/embedchain/config/AddConfig.py b/embedchain/config/AddConfig.py index 09eea5a7..db16170d 100644 --- a/embedchain/config/AddConfig.py +++ b/embedchain/config/AddConfig.py @@ -1,7 +1,7 @@ from typing import Callable, Optional from embedchain.config.BaseConfig import BaseConfig -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable @register_deserializable diff --git a/embedchain/config/BaseConfig.py b/embedchain/config/BaseConfig.py index 5a269b65..b02801f4 100644 --- a/embedchain/config/BaseConfig.py +++ b/embedchain/config/BaseConfig.py @@ -1,6 +1,6 @@ from typing import Any, Dict -from embedchain.helper_classes.json_serializable import JSONSerializable +from embedchain.helper.json_serializable import JSONSerializable class BaseConfig(JSONSerializable): diff --git a/embedchain/config/apps/AppConfig.py b/embedchain/config/apps/AppConfig.py index a7ead3b6..0833ccdf 100644 --- a/embedchain/config/apps/AppConfig.py +++ b/embedchain/config/apps/AppConfig.py @@ -1,6 +1,6 @@ from typing import Optional -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable from .BaseAppConfig import BaseAppConfig diff --git a/embedchain/config/apps/BaseAppConfig.py b/embedchain/config/apps/BaseAppConfig.py index f36d9752..4a76153b 100644 --- a/embedchain/config/apps/BaseAppConfig.py +++ b/embedchain/config/apps/BaseAppConfig.py @@ -2,8 +2,8 @@ import logging from typing import Optional from embedchain.config.BaseConfig import BaseConfig -from embedchain.helper_classes.json_serializable import JSONSerializable -from embedchain.vectordb.base_vector_db import BaseVectorDB +from embedchain.helper.json_serializable import JSONSerializable +from embedchain.vectordb.base import BaseVectorDB class BaseAppConfig(BaseConfig, JSONSerializable): diff --git a/embedchain/config/apps/CustomAppConfig.py b/embedchain/config/apps/CustomAppConfig.py index ca2ede28..4795dc31 100644 --- a/embedchain/config/apps/CustomAppConfig.py +++ b/embedchain/config/apps/CustomAppConfig.py @@ -2,8 +2,8 @@ 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 embedchain.helper.json_serializable import register_deserializable +from embedchain.vectordb.base import BaseVectorDB from .BaseAppConfig import BaseAppConfig diff --git a/embedchain/config/apps/OpenSourceAppConfig.py b/embedchain/config/apps/OpenSourceAppConfig.py index 7a8be7a3..c8c50c15 100644 --- a/embedchain/config/apps/OpenSourceAppConfig.py +++ b/embedchain/config/apps/OpenSourceAppConfig.py @@ -1,6 +1,6 @@ from typing import Optional -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable from .BaseAppConfig import BaseAppConfig diff --git a/embedchain/config/embedder/BaseEmbedderConfig.py b/embedchain/config/embedder/BaseEmbedderConfig.py index 5370fc27..8e8501e7 100644 --- a/embedchain/config/embedder/BaseEmbedderConfig.py +++ b/embedchain/config/embedder/BaseEmbedderConfig.py @@ -1,6 +1,6 @@ from typing import Optional -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable @register_deserializable diff --git a/embedchain/config/llm/base_llm_config.py b/embedchain/config/llm/base_llm_config.py index 4e31a572..6cf145fa 100644 --- a/embedchain/config/llm/base_llm_config.py +++ b/embedchain/config/llm/base_llm_config.py @@ -3,7 +3,7 @@ from string import Template from typing import Any, Dict, Optional from embedchain.config.BaseConfig import BaseConfig -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable DEFAULT_PROMPT = """ Use the following pieces of context to answer the query at the end. diff --git a/embedchain/config/vectordbs/ChromaDbConfig.py b/embedchain/config/vectordbs/ChromaDbConfig.py index bc2ecfad..a1b32559 100644 --- a/embedchain/config/vectordbs/ChromaDbConfig.py +++ b/embedchain/config/vectordbs/ChromaDbConfig.py @@ -1,7 +1,7 @@ from typing import Optional from embedchain.config.vectordbs.BaseVectorDbConfig import BaseVectorDbConfig -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable @register_deserializable diff --git a/embedchain/config/vectordbs/ElasticsearchDBConfig.py b/embedchain/config/vectordbs/ElasticsearchDBConfig.py index f7c2a743..1a0d0a87 100644 --- a/embedchain/config/vectordbs/ElasticsearchDBConfig.py +++ b/embedchain/config/vectordbs/ElasticsearchDBConfig.py @@ -1,7 +1,7 @@ from typing import Dict, List, Optional, Union from embedchain.config.vectordbs.BaseVectorDbConfig import BaseVectorDbConfig -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable @register_deserializable diff --git a/embedchain/data_formatter/data_formatter.py b/embedchain/data_formatter/data_formatter.py index 13a2ec45..e8db93d1 100644 --- a/embedchain/data_formatter/data_formatter.py +++ b/embedchain/data_formatter/data_formatter.py @@ -10,7 +10,7 @@ from embedchain.chunkers.web_page import WebPageChunker from embedchain.chunkers.youtube_video import YoutubeVideoChunker from embedchain.config import AddConfig from embedchain.config.AddConfig import ChunkerConfig, LoaderConfig -from embedchain.helper_classes.json_serializable import JSONSerializable +from embedchain.helper.json_serializable import JSONSerializable from embedchain.loaders.base_loader import BaseLoader from embedchain.loaders.csv import CsvLoader from embedchain.loaders.docs_site_loader import DocsSiteLoader diff --git a/embedchain/embedchain.py b/embedchain/embedchain.py index d47a65c1..d9daefa4 100644 --- a/embedchain/embedchain.py +++ b/embedchain/embedchain.py @@ -16,13 +16,13 @@ from embedchain.chunkers.base_chunker import BaseChunker from embedchain.config import AddConfig, BaseLlmConfig from embedchain.config.apps.BaseAppConfig import BaseAppConfig from embedchain.data_formatter import DataFormatter -from embedchain.embedder.base_embedder import BaseEmbedder -from embedchain.helper_classes.json_serializable import JSONSerializable -from embedchain.llm.base_llm import BaseLlm +from embedchain.embedder.base import BaseEmbedder +from embedchain.helper.json_serializable import JSONSerializable +from embedchain.llm.base import BaseLlm from embedchain.loaders.base_loader import BaseLoader from embedchain.models.data_type import DataType from embedchain.utils import detect_datatype -from embedchain.vectordb.base_vector_db import BaseVectorDB +from embedchain.vectordb.base import BaseVectorDB load_dotenv() diff --git a/embedchain/embedder/base_embedder.py b/embedchain/embedder/base.py similarity index 100% rename from embedchain/embedder/base_embedder.py rename to embedchain/embedder/base.py diff --git a/embedchain/embedder/gpt4all_embedder.py b/embedchain/embedder/gpt4all.py similarity index 93% rename from embedchain/embedder/gpt4all_embedder.py rename to embedchain/embedder/gpt4all.py index 9b06393a..5c443d56 100644 --- a/embedchain/embedder/gpt4all_embedder.py +++ b/embedchain/embedder/gpt4all.py @@ -3,7 +3,7 @@ from typing import Optional from chromadb.utils import embedding_functions from embedchain.config import BaseEmbedderConfig -from embedchain.embedder.base_embedder import BaseEmbedder +from embedchain.embedder.base import BaseEmbedder from embedchain.models import EmbeddingFunctions diff --git a/embedchain/embedder/huggingface_embedder.py b/embedchain/embedder/huggingface.py similarity index 91% rename from embedchain/embedder/huggingface_embedder.py rename to embedchain/embedder/huggingface.py index 9565ad54..d0ffabfd 100644 --- a/embedchain/embedder/huggingface_embedder.py +++ b/embedchain/embedder/huggingface.py @@ -3,7 +3,7 @@ from typing import Optional from langchain.embeddings import HuggingFaceEmbeddings from embedchain.config import BaseEmbedderConfig -from embedchain.embedder.base_embedder import BaseEmbedder +from embedchain.embedder.base import BaseEmbedder from embedchain.models import EmbeddingFunctions diff --git a/embedchain/embedder/openai_embedder.py b/embedchain/embedder/openai.py similarity index 96% rename from embedchain/embedder/openai_embedder.py rename to embedchain/embedder/openai.py index b174c6a6..6480e9b2 100644 --- a/embedchain/embedder/openai_embedder.py +++ b/embedchain/embedder/openai.py @@ -4,7 +4,7 @@ from typing import Optional from langchain.embeddings import OpenAIEmbeddings from embedchain.config import BaseEmbedderConfig -from embedchain.embedder.base_embedder import BaseEmbedder +from embedchain.embedder.base import BaseEmbedder from embedchain.models import EmbeddingFunctions try: diff --git a/embedchain/embedder/vertexai_embedder.py b/embedchain/embedder/vertexai.py similarity index 91% rename from embedchain/embedder/vertexai_embedder.py rename to embedchain/embedder/vertexai.py index 891de5bb..f03eda7b 100644 --- a/embedchain/embedder/vertexai_embedder.py +++ b/embedchain/embedder/vertexai.py @@ -3,7 +3,7 @@ from typing import Optional from langchain.embeddings import VertexAIEmbeddings from embedchain.config import BaseEmbedderConfig -from embedchain.embedder.base_embedder import BaseEmbedder +from embedchain.embedder.base import BaseEmbedder from embedchain.models import EmbeddingFunctions diff --git a/embedchain/helper_classes/json_serializable.py b/embedchain/helper/json_serializable.py similarity index 100% rename from embedchain/helper_classes/json_serializable.py rename to embedchain/helper/json_serializable.py diff --git a/embedchain/llm/antrophic_llm.py b/embedchain/llm/antrophic.py similarity index 87% rename from embedchain/llm/antrophic_llm.py rename to embedchain/llm/antrophic.py index 90950fa6..041a45c9 100644 --- a/embedchain/llm/antrophic_llm.py +++ b/embedchain/llm/antrophic.py @@ -2,8 +2,8 @@ import logging from typing import Optional from embedchain.config import BaseLlmConfig -from embedchain.helper_classes.json_serializable import register_deserializable -from embedchain.llm.base_llm import BaseLlm +from embedchain.helper.json_serializable import register_deserializable +from embedchain.llm.base import BaseLlm @register_deserializable diff --git a/embedchain/llm/azure_openai_llm.py b/embedchain/llm/azure_openai.py similarity index 83% rename from embedchain/llm/azure_openai_llm.py rename to embedchain/llm/azure_openai.py index 40703446..7d9b2f8f 100644 --- a/embedchain/llm/azure_openai_llm.py +++ b/embedchain/llm/azure_openai.py @@ -2,17 +2,17 @@ import logging from typing import Optional from embedchain.config import BaseLlmConfig -from embedchain.helper_classes.json_serializable import register_deserializable -from embedchain.llm.base_llm import BaseLlm +from embedchain.helper.json_serializable import register_deserializable +from embedchain.llm.base import BaseLlm @register_deserializable -class AzureOpenAiLlm(BaseLlm): +class AzureOpenAILlm(BaseLlm): def __init__(self, config: Optional[BaseLlmConfig] = None): super().__init__(config=config) def get_llm_model_answer(self, prompt): - return AzureOpenAiLlm._get_azure_openai_answer(prompt=prompt, config=self.config) + return AzureOpenAILlm._get_azure_openai_answer(prompt=prompt, config=self.config) @staticmethod def _get_azure_openai_answer(prompt: str, config: BaseLlmConfig) -> str: diff --git a/embedchain/llm/base_llm.py b/embedchain/llm/base.py similarity index 99% rename from embedchain/llm/base_llm.py rename to embedchain/llm/base.py index 451bd147..486c66e4 100644 --- a/embedchain/llm/base_llm.py +++ b/embedchain/llm/base.py @@ -8,7 +8,7 @@ from embedchain.config import BaseLlmConfig from embedchain.config.llm.base_llm_config import ( DEFAULT_PROMPT, DEFAULT_PROMPT_WITH_HISTORY_TEMPLATE, DOCS_SITE_PROMPT_TEMPLATE) -from embedchain.helper_classes.json_serializable import JSONSerializable +from embedchain.helper.json_serializable import JSONSerializable class BaseLlm(JSONSerializable): diff --git a/embedchain/llm/gpt4all_llm.py b/embedchain/llm/gpt4all.py similarity index 92% rename from embedchain/llm/gpt4all_llm.py rename to embedchain/llm/gpt4all.py index d08ea91f..48fd844b 100644 --- a/embedchain/llm/gpt4all_llm.py +++ b/embedchain/llm/gpt4all.py @@ -1,8 +1,8 @@ from typing import Iterable, Optional, Union from embedchain.config import BaseLlmConfig -from embedchain.helper_classes.json_serializable import register_deserializable -from embedchain.llm.base_llm import BaseLlm +from embedchain.helper.json_serializable import register_deserializable +from embedchain.llm.base import BaseLlm @register_deserializable diff --git a/embedchain/llm/llama2_llm.py b/embedchain/llm/llama2.py similarity index 88% rename from embedchain/llm/llama2_llm.py rename to embedchain/llm/llama2.py index 42ec1eff..68958589 100644 --- a/embedchain/llm/llama2_llm.py +++ b/embedchain/llm/llama2.py @@ -4,8 +4,8 @@ from typing import Optional from langchain.llms import Replicate from embedchain.config import BaseLlmConfig -from embedchain.helper_classes.json_serializable import register_deserializable -from embedchain.llm.base_llm import BaseLlm +from embedchain.helper.json_serializable import register_deserializable +from embedchain.llm.base import BaseLlm @register_deserializable diff --git a/embedchain/llm/openai_llm.py b/embedchain/llm/openai.py similarity index 89% rename from embedchain/llm/openai_llm.py rename to embedchain/llm/openai.py index f22b271f..d21cfb6b 100644 --- a/embedchain/llm/openai_llm.py +++ b/embedchain/llm/openai.py @@ -3,12 +3,12 @@ from typing import Optional import openai from embedchain.config import BaseLlmConfig -from embedchain.helper_classes.json_serializable import register_deserializable -from embedchain.llm.base_llm import BaseLlm +from embedchain.helper.json_serializable import register_deserializable +from embedchain.llm.base import BaseLlm @register_deserializable -class OpenAiLlm(BaseLlm): +class OpenAILlm(BaseLlm): def __init__(self, config: Optional[BaseLlmConfig] = None): super().__init__(config=config) diff --git a/embedchain/llm/vertex_ai_llm.py b/embedchain/llm/vertex_ai.py similarity index 87% rename from embedchain/llm/vertex_ai_llm.py rename to embedchain/llm/vertex_ai.py index a5a9927a..b6224e0c 100644 --- a/embedchain/llm/vertex_ai_llm.py +++ b/embedchain/llm/vertex_ai.py @@ -2,8 +2,8 @@ import logging from typing import Optional from embedchain.config import BaseLlmConfig -from embedchain.helper_classes.json_serializable import register_deserializable -from embedchain.llm.base_llm import BaseLlm +from embedchain.helper.json_serializable import register_deserializable +from embedchain.llm.base import BaseLlm @register_deserializable diff --git a/embedchain/loaders/base_loader.py b/embedchain/loaders/base_loader.py index c0861f88..bba58b81 100644 --- a/embedchain/loaders/base_loader.py +++ b/embedchain/loaders/base_loader.py @@ -1,4 +1,4 @@ -from embedchain.helper_classes.json_serializable import JSONSerializable +from embedchain.helper.json_serializable import JSONSerializable class BaseLoader(JSONSerializable): diff --git a/embedchain/loaders/docs_site_loader.py b/embedchain/loaders/docs_site_loader.py index 06d351d8..11c9758e 100644 --- a/embedchain/loaders/docs_site_loader.py +++ b/embedchain/loaders/docs_site_loader.py @@ -4,7 +4,7 @@ from urllib.parse import urljoin, urlparse import requests from bs4 import BeautifulSoup -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable from embedchain.loaders.base_loader import BaseLoader diff --git a/embedchain/loaders/docx_file.py b/embedchain/loaders/docx_file.py index c657d78b..5ea1931b 100644 --- a/embedchain/loaders/docx_file.py +++ b/embedchain/loaders/docx_file.py @@ -1,6 +1,6 @@ from langchain.document_loaders import Docx2txtLoader -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable from embedchain.loaders.base_loader import BaseLoader diff --git a/embedchain/loaders/local_qna_pair.py b/embedchain/loaders/local_qna_pair.py index 4fd1571a..5130f184 100644 --- a/embedchain/loaders/local_qna_pair.py +++ b/embedchain/loaders/local_qna_pair.py @@ -1,4 +1,4 @@ -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable from embedchain.loaders.base_loader import BaseLoader diff --git a/embedchain/loaders/local_text.py b/embedchain/loaders/local_text.py index 92e26a9e..80b13d29 100644 --- a/embedchain/loaders/local_text.py +++ b/embedchain/loaders/local_text.py @@ -1,4 +1,4 @@ -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable from embedchain.loaders.base_loader import BaseLoader diff --git a/embedchain/loaders/notion.py b/embedchain/loaders/notion.py index b9f894df..ad6c93a6 100644 --- a/embedchain/loaders/notion.py +++ b/embedchain/loaders/notion.py @@ -9,7 +9,7 @@ except ImportError: ) from None -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable from embedchain.loaders.base_loader import BaseLoader from embedchain.utils import clean_string diff --git a/embedchain/loaders/pdf_file.py b/embedchain/loaders/pdf_file.py index 7844b145..4084299f 100644 --- a/embedchain/loaders/pdf_file.py +++ b/embedchain/loaders/pdf_file.py @@ -1,6 +1,6 @@ from langchain.document_loaders import PyPDFLoader -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable from embedchain.loaders.base_loader import BaseLoader from embedchain.utils import clean_string diff --git a/embedchain/loaders/sitemap.py b/embedchain/loaders/sitemap.py index 3a9109b8..555cbe72 100644 --- a/embedchain/loaders/sitemap.py +++ b/embedchain/loaders/sitemap.py @@ -4,7 +4,7 @@ import requests from bs4 import BeautifulSoup from bs4.builder import ParserRejectedMarkup -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable from embedchain.loaders.base_loader import BaseLoader from embedchain.loaders.web_page import WebPageLoader from embedchain.utils import is_readable diff --git a/embedchain/loaders/web_page.py b/embedchain/loaders/web_page.py index cc562499..9b6b8d94 100644 --- a/embedchain/loaders/web_page.py +++ b/embedchain/loaders/web_page.py @@ -3,7 +3,7 @@ import logging import requests from bs4 import BeautifulSoup -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable from embedchain.loaders.base_loader import BaseLoader from embedchain.utils import clean_string diff --git a/embedchain/loaders/youtube_video.py b/embedchain/loaders/youtube_video.py index af36fba0..7a606064 100644 --- a/embedchain/loaders/youtube_video.py +++ b/embedchain/loaders/youtube_video.py @@ -1,6 +1,6 @@ from langchain.document_loaders import YoutubeLoader -from embedchain.helper_classes.json_serializable import register_deserializable +from embedchain.helper.json_serializable import register_deserializable from embedchain.loaders.base_loader import BaseLoader from embedchain.utils import clean_string diff --git a/embedchain/vectordb/base_vector_db.py b/embedchain/vectordb/base.py similarity index 94% rename from embedchain/vectordb/base_vector_db.py rename to embedchain/vectordb/base.py index 8fa0ec74..b877ab0b 100644 --- a/embedchain/vectordb/base_vector_db.py +++ b/embedchain/vectordb/base.py @@ -1,6 +1,6 @@ from embedchain.config.vectordbs.BaseVectorDbConfig import BaseVectorDbConfig -from embedchain.embedder.base_embedder import BaseEmbedder -from embedchain.helper_classes.json_serializable import JSONSerializable +from embedchain.embedder.base import BaseEmbedder +from embedchain.helper.json_serializable import JSONSerializable class BaseVectorDB(JSONSerializable): diff --git a/embedchain/vectordb/chroma_db.py b/embedchain/vectordb/chroma.py similarity index 98% rename from embedchain/vectordb/chroma_db.py rename to embedchain/vectordb/chroma.py index de7a928c..84f45840 100644 --- a/embedchain/vectordb/chroma_db.py +++ b/embedchain/vectordb/chroma.py @@ -5,8 +5,8 @@ from chromadb import Collection, QueryResult from langchain.docstore.document import Document from embedchain.config import ChromaDbConfig -from embedchain.helper_classes.json_serializable import register_deserializable -from embedchain.vectordb.base_vector_db import BaseVectorDB +from embedchain.helper.json_serializable import register_deserializable +from embedchain.vectordb.base import BaseVectorDB try: import chromadb diff --git a/embedchain/vectordb/elasticsearch_db.py b/embedchain/vectordb/elasticsearch.py similarity index 95% rename from embedchain/vectordb/elasticsearch_db.py rename to embedchain/vectordb/elasticsearch.py index 2125e701..f03c0b34 100644 --- a/embedchain/vectordb/elasticsearch_db.py +++ b/embedchain/vectordb/elasticsearch.py @@ -9,8 +9,8 @@ except ImportError: ) from None from embedchain.config import ElasticsearchDBConfig -from embedchain.helper_classes.json_serializable import register_deserializable -from embedchain.vectordb.base_vector_db import BaseVectorDB +from embedchain.helper.json_serializable import register_deserializable +from embedchain.vectordb.base import BaseVectorDB @register_deserializable diff --git a/pyproject.toml b/pyproject.toml index 1f3a07c2..afa1113a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "embedchain" -version = "0.0.54" +version = "0.0.55" description = "embedchain is a framework to easily create LLM powered bots over any dataset" authors = ["Taranjeet Singh"] license = "Apache License" diff --git a/tests/embedchain/test_embedchain.py b/tests/embedchain/test_embedchain.py index 86ad452e..8122c61a 100644 --- a/tests/embedchain/test_embedchain.py +++ b/tests/embedchain/test_embedchain.py @@ -12,8 +12,8 @@ class TestChromaDbHostsLoglevel(unittest.TestCase): @patch("chromadb.api.models.Collection.Collection.add") @patch("chromadb.api.models.Collection.Collection.get") @patch("embedchain.embedchain.EmbedChain.retrieve_from_database") - @patch("embedchain.llm.base_llm.BaseLlm.get_answer_from_llm") - @patch("embedchain.llm.base_llm.BaseLlm.get_llm_model_answer") + @patch("embedchain.llm.base.BaseLlm.get_answer_from_llm") + @patch("embedchain.llm.base.BaseLlm.get_llm_model_answer") def test_whole_app( self, _mock_get, diff --git a/tests/helper_classes/test_json_serializable.py b/tests/helper_classes/test_json_serializable.py index 36b0f045..c99bfd3e 100644 --- a/tests/helper_classes/test_json_serializable.py +++ b/tests/helper_classes/test_json_serializable.py @@ -3,8 +3,8 @@ import unittest from embedchain import App from embedchain.config import AppConfig -from embedchain.helper_classes.json_serializable import ( - JSONSerializable, register_deserializable) +from embedchain.helper.json_serializable import (JSONSerializable, + register_deserializable) class TestJsonSerializable(unittest.TestCase): diff --git a/tests/llm/test_chat.py b/tests/llm/test_chat.py index a5340b07..6bffd23f 100644 --- a/tests/llm/test_chat.py +++ b/tests/llm/test_chat.py @@ -4,7 +4,7 @@ from unittest.mock import MagicMock, patch from embedchain import App from embedchain.config import AppConfig, BaseLlmConfig -from embedchain.llm.base_llm import BaseLlm +from embedchain.llm.base import BaseLlm class TestApp(unittest.TestCase): diff --git a/tests/vectordb/test_chroma_db.py b/tests/vectordb/test_chroma_db.py index 79d1ce96..b87e3a02 100644 --- a/tests/vectordb/test_chroma_db.py +++ b/tests/vectordb/test_chroma_db.py @@ -7,7 +7,7 @@ from chromadb.config import Settings from embedchain import App from embedchain.config import AppConfig, ChromaDbConfig -from embedchain.vectordb.chroma_db import ChromaDB +from embedchain.vectordb.chroma import ChromaDB class TestChromaDbHosts(unittest.TestCase): @@ -46,7 +46,7 @@ class TestChromaDbHosts(unittest.TestCase): # Review this test class TestChromaDbHostsInit(unittest.TestCase): - @patch("embedchain.vectordb.chroma_db.chromadb.Client") + @patch("embedchain.vectordb.chroma.chromadb.Client") def test_app_init_with_host_and_port(self, mock_client): """ Test if the `App` instance is initialized with the correct host and port values. @@ -66,7 +66,7 @@ class TestChromaDbHostsInit(unittest.TestCase): class TestChromaDbHostsNone(unittest.TestCase): - @patch("embedchain.vectordb.chroma_db.chromadb.Client") + @patch("embedchain.vectordb.chroma.chromadb.Client") def test_init_with_host_and_port_none(self, mock_client): """ Test if the `App` instance is initialized without default hosts and ports. @@ -80,7 +80,7 @@ class TestChromaDbHostsNone(unittest.TestCase): class TestChromaDbHostsLoglevel(unittest.TestCase): - @patch("embedchain.vectordb.chroma_db.chromadb.Client") + @patch("embedchain.vectordb.chroma.chromadb.Client") def test_init_with_host_and_port_log_level(self, mock_client): """ Test if the `App` instance is initialized without a config that does not contain default hosts and ports. diff --git a/tests/vectordb/test_elasticsearch_db.py b/tests/vectordb/test_elasticsearch_db.py index ed75030b..ae85be25 100644 --- a/tests/vectordb/test_elasticsearch_db.py +++ b/tests/vectordb/test_elasticsearch_db.py @@ -1,8 +1,8 @@ import unittest from embedchain.config import ElasticsearchDBConfig -from embedchain.embedder.base_embedder import BaseEmbedder -from embedchain.vectordb.elasticsearch_db import ElasticsearchDB +from embedchain.embedder.base import BaseEmbedder +from embedchain.vectordb.elasticsearch import ElasticsearchDB class TestEsDB(unittest.TestCase):