diff --git a/.env.example b/.env.example index 84f9ebbb76..2d57e329be 100644 --- a/.env.example +++ b/.env.example @@ -1,8 +1,23 @@ -WEAVIATE_URL_VERBA=URL-TO-YOUR-WEAVIATE-CLUSTER -WEAVIATE_API_KEY_VERBA=API-KEY-OF-YOUR-WEAVIATE-CLUSTER -OPENAI_API_KEY=YOUR-OPENAI-KEY -COHERE_API_KEY=YOUR-COHERE-KEY -UNSTRUCTURED_API_KEY=YOUR-UNSTRUCTURED-KEY -GITHUB_TOKEN=YOUR-GITHUB-TOKEN -HF_TOKEN=YOUR-HUGGINGFACE-TOKEN -LLAMA2-7B-CHAT-HF=ENABLE-LLAMA2?-(True or False) \ No newline at end of file +# URL-TO-YOUR-WEAVIATE-CLUSTER +WEAVIATE_URL_VERBA= + +# API-KEY-OF-YOUR-WEAVIATE-CLUSTER +WEAVIATE_API_KEY_VERBA= + +# YOUR-OPENAI-KEY +OPENAI_API_KEY= + +# YOUR-COHERE-KEY +COHERE_API_KEY= + +# YOUR-UNSTRUCTURED-KEY +UNSTRUCTURED_API_KEY= + +# YOUR-GITHUB-TOKEN +GITHUB_TOKEN= + +# YOUR-HUGGINGFACE-TOKEN +HF_TOKEN= + +# ENABLE-LLAMA2?-(True or False) +LLAMA2-7B-CHAT-HF= \ No newline at end of file diff --git a/.gitignore b/.gitignore index 23d1cc0c84..21fbdc10be 100644 --- a/.gitignore +++ b/.gitignore @@ -12,4 +12,6 @@ build .verba .vscode verba_config.json -text-generation-inference \ No newline at end of file +text-generation-inference +test.py +cache.txt \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 8321f94bd2..ecf27c75b1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,6 +20,7 @@ All notable changes to this project will be documented in this file. - Added LLama 2 and Cohere support - Added new OpenAI models - Improved Documentation +- Added technical docs and contribution guidelines ### Fixed - Error handling for data ingestion (handling chunk size)