bump: version 1.4.1 → 1.5.0

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.5.0 (2023-01-29)
+
+### Feat
+
+- Allow user to specify a different LLM instead of OpenAI
+
 ## 1.4.1 (2023-01-14)
 
 ### Fix

README.md

@@ -41,6 +41,8 @@ Here I'm using a PDF file generated from this page [Parable of a Monetary Econom
 
 Before running this, you need to set up your OpenAI API key. You can get it from [OpenAI](https://beta.openai.com/account/api-keys).
 
+> From version 1.5.0, you can skip OpenAI and use HuggingFace models to generate embeddings and answers.
+
 ```shell
 export OPENAI_API_KEY=<your-openai-api-key>
 ```
@@ -51,6 +53,12 @@ The run the following command to start the training process:
 dr-doc-search --train -i ~/Downloads/parable-of-a-monetary-economy-heteconomist.pdf
 ```
 
+Use `huggingface` for generating embeddings:
+
+```shell
+dr-doc-search --train -i ~/Downloads/parable-of-a-monetary-economy-heteconomist.pdf --embedding huggingface
+```
+
 The training process generates some temporary files in the `OutputDir/dr-doc-search/<pdf-name>` folder under your home directory.
 Here is what it looks like:
 
@@ -89,6 +97,12 @@ Or You can open up a web interface (on port :5006) to ask questions:
 dr-doc-search --web-app -i ~/Downloads/parable-of-a-monetary-economy-heteconomist.pdf
 ```
 
+To use `huggingface` model, provide the `--llm` argument:
+
+```shell
+dr-doc-search --web-app -i ~/Downloads/parable-of-a-monetary-economy-heteconomist.pdf --llm huggingface
+```
+
 There are more options for choose the start and end pages for the PDF file.
 See the help for more details:
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "dr-doc-search"
-version = "1.4.1"
+version = "1.5.0"
 description = "Search through a document using a chat interface"
 authors = [
     "namuan <github@deskriders.dev>",
@@ -71,7 +71,7 @@ mkdocstrings-python = "^0.8.3"
 
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "1.4.1"
+version = "1.5.0"
 tag_format = "$version"
 version_files = [
     "pyproject.toml:version",