Movie-search demo

Dockerfile

@@ -0,0 +1,36 @@
+FROM python:3.8
+
+WORKDIR /code
+
+# install poetry
+RUN curl -sSL https://install.python-poetry.org | POETRY_VERSION=1.4.2 python3 -
+ENV PATH="${PATH}:/root/.local/bin"
+# copy poetry configs and lock file
+COPY pyproject.toml poetry.lock ./
+
+# Install dependencies
+RUN poetry config virtualenvs.create false && poetry install --no-root --no-interaction
+
+# Set up a new user named "user" with user ID 1000
+RUN useradd -m -u 1000 user
+# Switch to the "user" user
+USER user
+# Set home to the user's home directory
+ENV HOME=/home/user \
+    PATH=/home/user/.local/bin:$PATH
+
+# Set the working directory to the user's home directory
+WORKDIR $HOME/app
+
+# Copy the current directory contents into the container at $HOME/app setting the owner to the user
+COPY --chown=user . $HOME/app
+
+# Get secret EXAMPLE and output it to /test at buildtime
+RUN --mount=type=secret,id=PINECONE_API_ENV,mode=0444,required=true
+RUN --mount=type=secret,id=INDEX,mode=0444,required=true
+RUN --mount=type=secret,id=PINECONE_API_KEY,mode=0444,required=true
+
+EXPOSE 7860
+
+CMD ["python", "./movies-search-demo/app.py"]
+

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

Makefile

@@ -0,0 +1,57 @@
+SHELL := /bin/bash
+
+venv:
+	python -m venv venv
+
+.PHONY: install
+install: ## Install main dependencies
+	poetry install --sync
+
+.PHONY: install-dev
+install: ## Install dependencies including dev dependencies such as test and docs
+	poetry install --sync --with test,docs
+
+.PHONY: ruff
+ruff:
+	ruff check .
+
+.PHONY: bandit
+bandit:
+	bandit -r . -c pyproject.toml
+
+.PHONY: mypy
+mypy:
+	mypy . --config-file pyproject.toml
+
+.PHONY: style
+style:
+	ruff check . --fix
+	mypy . --config-file pyproject.toml
+	bandit -r . -c pyproject.toml
+
+.PHONY: run
+run:
+	python -m $(demo).app
+
+.PHONY: build
+build:
+	docker build -t $(CONTAINER_REGISTRY)/$(IMAGE_NAME):$(or $(tag), $(DEFAULT_IMAGE_TAG)) .
+
+.PHONY: push
+push:
+	docker push $(CONTAINER_REGISTRY)/$(IMAGE_NAME):$(or $(tag), $(DEFAULT_IMAGE_TAG))
+
+.PHONY: docker-run
+docker-run:
+	docker run -it --rm -p 7860:7860 \
+	$(CONTAINER_REGISTRY)/$(IMAGE_NAME):$(or $(tag), $(DEFAULT_IMAGE_TAG)) \
+	python -m $(demo).app
+
+.PHONY: clean
+clean:
+	find . -type f -name "*.DS_Store" -ls -delete
+	find . | grep -E "(__pycache__|\.pyc|\.pyo)" | xargs rm -rf
+	find . | grep -E ".pytest_cache" | xargs rm -rf
+	find . | grep -E ".mypy_cache" | xargs rm -rf
+	find . | grep -E ".ruff_cache" | xargs rm -rf
+	find . | grep -E ".ipynb_checkpoints" | xargs rm -rf

movies-search-demo/app.py

@@ -0,0 +1,55 @@
+import os
+
+import gradio as gr
+import pinecone
+from langchain.chains import RetrievalQA
+from langchain.embeddings.openai import OpenAIEmbeddings
+from langchain.llms import OpenAI
+from langchain.vectorstores import Pinecone
+
+
+def query_movies_db(openai_api_key: str, query: str) -> str:
+    # initialize pinecone
+    pinecone.init(
+        api_key=os.environ["PINECONE_API_KEY"],  # find at app.pinecone.io
+        environment=os.environ["PINECONE_API_ENV"],  # next to api key in console
+    )
+
+    embeddings = OpenAIEmbeddings(openai_api_key=openai_api_key)
+
+    docsearch = Pinecone.from_existing_index(
+        index_name=os.environ["INDEX_NAME"],
+        embedding=embeddings,
+    )
+
+    qa = RetrievalQA.from_chain_type(
+        llm=OpenAI(openai_api_key=openai_api_key),
+        chain_type="stuff",
+        retriever=docsearch.as_retriever(),
+    )
+
+    return qa.run(query)
+
+
+demo = gr.Interface(
+    fn=query_movies_db,
+    inputs=[
+        gr.inputs.Textbox(
+            placeholder="openai-api-key",
+            type="password",
+            label="Set OpenAI API Key",
+        ),
+        gr.inputs.Textbox(
+            lines=5,
+            label="Input Text",
+            default="Similar movies to The Dark Knight Rises",
+        ),
+    ],
+    outputs=[gr.outputs.Textbox(label="LLM Response")],
+    title="Query about Movies",
+    description="The tool queries a database of movies and"
+    "uses the OpenAI LLM to generate a response.",
+)
+
+if __name__ == "__main__":
+    demo.launch(server_name="0.0.0.0")

pyproject.toml

@@ -0,0 +1,79 @@
+[build-system]
+requires = ["poetry-core==1.4.2"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+name = "LLMazing-Use-Cases"
+version = "0.0.1"
+description = "An assembly of use cases for LLMs."
+authors = [
+    "Maximilian Gartz <gartz.maximilian@gmail.com>",
+    "Shubham Krishna <shubhamkrishna.ism@gmail.com>",
+    "Sören Erichsen <soeren.erichsen99@gmail.com>"
+]
+license = "Apache-2.0"
+readme = "README.md"
+packages = []
+homepage = ""
+repository = "https://github.com/shub-kris/LLMazing-Use-Cases"
+documentation = ""
+keywords = []
+classifiers = []
+
+[tool.poetry.dependencies]
+python = ">=3.8.1,<3.9.16"
+langchain = "^0.0.131"
+llama-index = "^0.5.7"
+gradio = "^3.25.0"
+setuptools = "^67.6.1"
+feedparser = "^6.0.10"
+pinecone-client = "^2.2.1"
+
+[tool.poetry.group.test]
+optional = true
+
+[tool.poetry.group.test.dependencies]
+ruff = "^0.0.261"
+mypy = "^1.1.1"
+bandit = "^1.7.5"
+
+[tool.poetry.group.docs]
+optional = true
+
+[tool.poetry.group.docs.dependencies]
+mkdocs = "^1.4.2"
+
+[tool.ruff]
+select = ["E", "F"]
+ignore = []
+fixable = ["A", "B", "C", "D", "E", "F"]
+unfixable = []
+src = ["."]
+exclude = ["venv"]
+per-file-ignores = { }
+line-length = 100
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+target-version = "py38"
+
+[tool.ruff.mccabe]
+max-complexity = 10
+
+[tool.mypy]
+python_version = 3.8
+warn_return_any = false
+warn_unused_configs = true
+ignore_missing_imports = true
+follow_imports = "skip"
+disallow_untyped_defs = true
+disable_error_code = ["override", "attr-defined", "import", "empty-body"]
+exclude = ["venv/"]
+
+[tool.bandit]
+exclude_dirs = [
+    "**/test_*.py",
+    "./venv/",
+    "./*cache*/",
+    "./resources/",
+    "./notebooks/"
+]
+skips = ["B608"]