haystack app

Dockerfile

@@ -0,0 +1,14 @@
+# read the doc: https://huggingface.co/docs/hub/spaces-sdks-docker
+# you will also find guides on how best to write your Dockerfile
+
+FROM python:3.9
+
+WORKDIR /app
+
+RUN pip install --no-cache-dir --upgrade poetry
+
+COPY . .
+
+RUN poetry install 
+
+CMD ["poetry", "run", "chainlit", "run", "src/app.py", "--port", "7860"]

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.

README.md

@@ -1,11 +1,117 @@
----
-title: Seven Wonders Haystack
-emoji: 🦀
-colorFrom: red
-colorTo: blue
-sdk: docker
-pinned: false
-license: openrail
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Welcome! 
+
+This chatbot uses RAG to answer questions about the Seven Wonders of the Ancient World. 
+
+Here are sample questions you can ask it:
+
+1. What is the Great Pyramid of Giza?
+2. What is the Hanging Gardens of Babylon?
+3. What is the Temple of Artemis at Ephesus?
+4. What is the Statue of Zeus at Olympia?
+5. What is the Mausoleum at Halicarnassus?
+6. Where is Gardens of Babylon?
+7. Why did people build Great Pyramid of Giza?
+8. What does Rhodes Statue look like?
+9. Why did people visit the Temple of Artemis?
+10. What is the importance of Colossus of Rhodes?
+11. What happened to the Tomb of Mausolus?
+12. How did Colossus of Rhodes collapse?
+
+## How is it built?
+
+### Poetry package management
+
+This project uses [Poetry](https://python-poetry.org/) for package management.
+
+It uses [this `pyproject.toml` file](pyproject.toml)
+
+To install dependencies:
+
+```bash
+pip install poetry
+poetry install
+```
+
+### Data source: 
+
+The data is from the [Seven Wonders dataset][1] on Hugging Face. https://huggingface.co/datasets/bilgeyucel/seven-wonders
+
+### Method
+
+The chatbots retrieval mechanism is developed using Retrieval Augmented Generation (RAG) with [Haystack](https://haystack.deepset.ai/tutorials/22_pipeline_with_promptnode) and its user interface is built with [Chainlit](https://docs.chainlit.io/overview). It is using OpenAI GPT-3.5-turbo. 
+
+### Pipeline steps (Haystack) - check the full script here: [src/app.py](src/app.py)
+
+1. Initialize in-memory Document store
+
+```python
+# Initialize Haystack's QA system
+document_store = InMemoryDocumentStore(use_bm25=True)
+```
+2. Load dataset from HF
+
+```python
+dataset = load_dataset("bilgeyucel/seven-wonders", split="train")
+```
+
+3. Transform documents and load into document store
+
+```python
+document_store.write_documents(dataset)
+```
+4. Initialize a RAG prompt
+
+```
+rag_prompt = PromptTemplate(
+    prompt="""Synthesize a brief answer from the following text for the given question.
+                             Provide a clear and concise response that summarizes the key points and information presented in the text.
+                             Your answer should be in your own words and be no longer than 50 words.
+                             \n\n Related text: {join(documents)} \n\n Question: {query} \n\n Answer:""",
+    output_parser=AnswerParser(),
+)
+
+```
+
+5. Set the nodes using GPT-3.5-turbo
+
+```python
+ Set up nodes
+retriever = BM25Retriever(document_store=document_store, top_k=2)
+pn = PromptNode("gpt-3.5-turbo", 
+                api_key=MY_API_KEY, 
+                model_kwargs={"stream":False},
+                default_prompt_template=rag_prompt)
+
+```
+
+6. Build the pipeline
+
+```python
+# Set up pipeline
+pipe = Pipeline()
+pipe.add_node(component=retriever, name="retriever", inputs=["Query"])
+pipe.add_node(component=pn, name="prompt_node", inputs=["retriever"])
+```
+
+### Connecting the pipeline to Chainlit
+
+```python
+
+@cl.on_message
+async def main(message: str):
+    # Use the pipeline to get a response
+    output = pipe.run(query=message)
+
+    # Create a Chainlit message with the response
+    response = output['answers'][0].answer
+    msg = cl.Message(content=response)
+
+    # Send the message to the user
+    await msg.send()
+```
+
+### Run application
+
+``` bash
+poetry run chainlit run src/app.py --port 7860
+```

chainlit.md

@@ -0,0 +1,28 @@
+# Welcome! 
+
+This chatbot uses RAG to answer questions about the Seven Wonders of the Ancient World. 
+
+Here are sample questions you can ask it:
+
+1. What is the Great Pyramid of Giza?
+2. What is the Hanging Gardens of Babylon?
+3. What is the Temple of Artemis at Ephesus?
+4. What is the Statue of Zeus at Olympia?
+5. What is the Mausoleum at Halicarnassus?
+6. Where is Gardens of Babylon?
+7. Why did people build Great Pyramid of Giza?
+8. What does Rhodes Statue look like?
+9. Why did people visit the Temple of Artemis?
+10. What is the importance of Colossus of Rhodes?
+11. What happened to the Tomb of Mausolus?
+12. How did Colossus of Rhodes collapse?
+
+## How is it built?
+
+### Data source: 
+
+The data is from the [Seven Wonders dataset][1] on Hugging Face. https://huggingface.co/datasets/bilgeyucel/seven-wonders
+
+### Method
+
+The chatbots retrieval mechanism is developed using Retrieval Augmented Generation (RAG) with [Haystack](https://haystack.deepset.ai/tutorials/22_pipeline_with_promptnode) and its user interface is built with [Chainlit](https://docs.chainlit.io/overview). It is using OpenAI GPT-3.5-turbo. 

pyproject.toml

@@ -0,0 +1,22 @@
+[tool.poetry]
+name = "llmops-with-haystack"
+version = "0.1.0"
+description = ""
+authors = ["Laura Gutierrez Funderburk <[email protected]>"]
+license = "Apache 2.0"
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.10"
+farm-haystack = "^1.20.1"
+chainlit = "^0.7.0"
+openai = "^0.28.0"
+jupyter = "^1.0.0"
+ipykernel = "^6.25.2"
+python-dotenv = "^1.0.0"
+datasets = "^2.14.5"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

src/app.py

@@ -0,0 +1,56 @@
+# Imports and Initializations for Chainlit
+import chainlit as cl
+from dotenv import load_dotenv
+
+# Imports and Initializations for Haystack
+from haystack.document_stores import InMemoryDocumentStore
+from datasets import load_dataset
+from haystack.nodes import BM25Retriever, PromptTemplate, AnswerParser, PromptNode
+import os
+from haystack.pipelines import Pipeline
+
+# Load environment variables (if any)
+load_dotenv(".env")
+MY_API_KEY = os.getenv("OPENAI_API_KEY")
+
+# Initialize Haystack's QA system
+document_store = InMemoryDocumentStore(use_bm25=True)
+dataset = load_dataset("bilgeyucel/seven-wonders", split="train")
+document_store.write_documents(dataset)
+
+
+rag_prompt = PromptTemplate(
+    prompt="""Synthesize a brief answer from the following text for the given question.
+                             Provide a clear and concise response that summarizes the key points and information presented in the text.
+                             Your answer should be in your own words and be no longer than 50 words.
+                             \n\n Related text: {join(documents)} \n\n Question: {query} \n\n Answer:""",
+    output_parser=AnswerParser(),
+)
+
+# Set up nodes
+retriever = BM25Retriever(document_store=document_store, top_k=2)
+pn = PromptNode("gpt-3.5-turbo", 
+                api_key=MY_API_KEY, 
+                model_kwargs={"stream":False},
+                default_prompt_template=rag_prompt)
+
+# Set up pipeline
+pipe = Pipeline()
+pipe.add_node(component=retriever, name="retriever", inputs=["Query"])
+pipe.add_node(component=pn, name="prompt_node", inputs=["retriever"])
+
+@cl.on_message
+async def main(message: str):
+    # Use the pipeline to get a response
+    output = pipe.run(query=message)
+
+    # Create a Chainlit message with the response
+    response = output['answers'][0].answer
+    msg = cl.Message(content=response)
+
+    # Send the message to the user
+    await msg.send()
+
+if __name__ == "__main__":
+    # You can add any Chainlit app initialization or run code here
+    pass