diff --git a/README.md b/README.md index be9b9a6..877424b 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ -# chainlite -LangChain + LiteLLM that works - -# ChainLite - -ChainLite combines LangChain and LiteLLM to provide an easy-to-use and customizable interface for large language model applications. +
+ ChainLite Logo +

ChainLite

+
+
+

ChainLite combines LangChain and LiteLLM to provide an easy-to-use and customizable interface for large language model applications.

+

* Logo is generated using DALL·E 3.

+
## Installation @@ -17,14 +19,15 @@ To install ChainLite, use the following steps: ``` -1. Copy `chainlite_config.yaml` to your project and follow the instructions there to update it with your own configuration. +1. Copy `llm_config.yaml` to your project and follow the instructions there to update it with your own configuration. ## Usage -Before you can use Chainlite, you need to call the following function to load the configuration file: +Before you can use Chainlite, you can call the following function to load the configuration file. If you don't, ChainLite will use `llm_config.yaml` in the current directory (the directory you are running your script from) by default. + ```python from chainlite import load_config_file -load_config_file("./chainlite_config.yaml") # The path should be relative to the directory you run the script from, usually the root directory of your project +load_config_file("./llm_config.yaml") # The path should be relative to the directory you run the script from, usually the root directory of your project ``` Make sure the corresponding API keys are set in environemnt variables with the name you specified in the configuration file, e.g. `OPENAI_API_KEY` etc. diff --git a/assets/logo.png b/assets/logo.png new file mode 100644 index 0000000..115c6c5 Binary files /dev/null and b/assets/logo.png differ diff --git a/chainlite/llm_config.py b/chainlite/llm_config.py index e74997d..71348d7 100644 --- a/chainlite/llm_config.py +++ b/chainlite/llm_config.py @@ -98,7 +98,7 @@ def load_config_from_file(config_file: str) -> None: # this code is not safe to use with multiprocessing, only multithreading thread_lock = threading.Lock() - +load_config_from_file("./llm_config.yaml") total_cost = 0.0 # in USD diff --git a/chainlite_config.yaml b/llm_config.yaml similarity index 100% rename from chainlite_config.yaml rename to llm_config.yaml diff --git a/setup.py b/setup.py index f770c30..739b088 100644 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ setup( name="chainlite", - version="0.1.9", + version="0.1.10", author="Sina Semnani", author_email="sinaj@cs.stanford.edu", description="A Python package that uses LangChain and LiteLLM to call large language model APIs easily", diff --git a/tests/test_llm_generate.py b/tests/test_llm_generate.py index a5ae682..710c5b7 100644 --- a/tests/test_llm_generate.py +++ b/tests/test_llm_generate.py @@ -8,7 +8,7 @@ logger = get_logger(__name__) -load_config_from_file("./chainlite_config.yaml") +# load_config_from_file("./llm_config.yaml") @pytest.mark.asyncio(scope="session") async def test_llm_generate():