Completed the HF space

.env.sample

@@ -0,0 +1,5 @@
+# !!! DO NOT UPDATE THIS FILE DIRECTLY. MAKE A COPY AND RENAME IT `.env` TO PROCEED !!! #
+HF_LLM_ENDPOINT="YOUR_LLM_ENDPOINT_URL_HERE"
+HF_EMBED_ENDPOINT="YOUR_EMBED_MODEL_ENDPOINT_URL_HERE"
+HF_TOKEN="YOUR_HF_TOKEN_HERE"
+# !!! DO NOT UPDATE THIS FILE DIRECTLY. MAKE A COPY AND RENAME IT `.env` TO PROCEED !!! #

.gitignore

@@ -0,0 +1,6 @@
+.env
+__pycache__/
+.chainlit
+*.faiss
+*.pkl
+.files

Dockerfile

@@ -0,0 +1,11 @@
+FROM python:3.9
+RUN useradd -m -u 1000 user
+USER user
+ENV HOME=/home/user \
+    PATH=/home/user/.local/bin:$PATH
+WORKDIR $HOME/app
+COPY --chown=user . $HOME/app
+COPY ./requirements.txt ~/app/requirements.txt
+RUN pip install -r requirements.txt
+COPY . .
+CMD ["chainlit", "run", "app.py", "--port", "7860"]

[Completed] BazeleyMikiko_Open_Source_RAG_Leveraging_Hugging_Face_Endpoints_through_LangChain.ipynb

@@ -0,0 +1,669 @@
+{
+  "nbformat": 4,
+  "nbformat_minor": 0,
+  "metadata": {
+    "colab": {
+      "provenance": []
+    },
+    "kernelspec": {
+      "name": "python3",
+      "display_name": "Python 3"
+    },
+    "language_info": {
+      "name": "python"
+    }
+  },
+  "cells": [
+    {
+      "cell_type": "markdown",
+      "source": [
+        "# Open Source RAG - Leveraging Hugging Face Endpoints through LangChain\n",
+        "\n",
+        "In the following notebook we will dive into the world of Open Source models hosted on Hugging Face's [inference endpoints](https://ui.endpoints.huggingface.co/).\n",
+        "\n",
+        "The notebook will be broken into the following parts:\n",
+        "\n",
+        "- 🤝 Breakout Room #2:\n",
+        "  1. Install required libraries\n",
+        "  2. Set Environment Variables\n",
+        "  3. Creating LangChain components powered by the endpoints\n",
+        "  4. Preparing Data!\n",
+        "  5. Simple LCEL RAG Chain"
+      ],
+      "metadata": {
+        "id": "lcW6UWldWUMp"
+      }
+    },
+    {
+      "cell_type": "markdown",
+      "source": [
+        "## Task 1: Install required libraries\n",
+        "\n",
+        "Now we've got to get our required libraries!\n",
+        "\n",
+        "We'll start with our `langchain` and `huggingface` dependencies.\n",
+        "\n"
+      ],
+      "metadata": {
+        "id": "-spIWt2J3Quk"
+      }
+    },
+    {
+      "cell_type": "code",
+      "source": [
+        "!pip install -qU langchain-huggingface langchain-community faiss-cpu"
+      ],
+      "metadata": {
+        "id": "EwGLnp31jXJj",
+        "outputId": "2b3d0cf7-5e88-4a91-c759-d6efb8f0fa5f",
+        "colab": {
+          "base_uri": "https://localhost:8080/"
+        }
+      },
+      "execution_count": 1,
+      "outputs": [
+        {
+          "output_type": "stream",
+          "name": "stdout",
+          "text": [
+            "\u001b[2K     \u001b[90m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\u001b[0m \u001b[32m2.2/2.2 MB\u001b[0m \u001b[31m10.4 MB/s\u001b[0m eta \u001b[36m0:00:00\u001b[0m\n",
+            "\u001b[2K     \u001b[90m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\u001b[0m \u001b[32m27.0/27.0 MB\u001b[0m \u001b[31m26.8 MB/s\u001b[0m eta \u001b[36m0:00:00\u001b[0m\n",
+            "\u001b[2K     \u001b[90m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\u001b[0m \u001b[32m321.8/321.8 kB\u001b[0m \u001b[31m7.7 MB/s\u001b[0m eta \u001b[36m0:00:00\u001b[0m\n",
+            "\u001b[2K     \u001b[90m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\u001b[0m \u001b[32m227.1/227.1 kB\u001b[0m \u001b[31m13.5 MB/s\u001b[0m eta \u001b[36m0:00:00\u001b[0m\n",
+            "\u001b[2K     \u001b[90m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\u001b[0m \u001b[32m974.6/974.6 kB\u001b[0m \u001b[31m34.4 MB/s\u001b[0m eta \u001b[36m0:00:00\u001b[0m\n",
+            "\u001b[2K     \u001b[90m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\u001b[0m \u001b[32m127.1/127.1 kB\u001b[0m \u001b[31m7.0 MB/s\u001b[0m eta \u001b[36m0:00:00\u001b[0m\n",
+            "\u001b[2K     \u001b[90m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\u001b[0m \u001b[32m49.2/49.2 kB\u001b[0m \u001b[31m3.0 MB/s\u001b[0m eta \u001b[36m0:00:00\u001b[0m\n",
+            "\u001b[2K     \u001b[90m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\u001b[0m \u001b[32m145.0/145.0 kB\u001b[0m \u001b[31m3.4 MB/s\u001b[0m eta \u001b[36m0:00:00\u001b[0m\n",
+            "\u001b[2K     \u001b[90m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\u001b[0m \u001b[32m21.3/21.3 MB\u001b[0m \u001b[31m42.8 MB/s\u001b[0m eta \u001b[36m0:00:00\u001b[0m\n",
+            "\u001b[?25h"
+          ]
+        }
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "source": [
+        "## Task 2: Set Environment Variables\n",
+        "\n",
+        "We'll need to set our `HF_TOKEN` so that we can send requests to our protected API endpoint.\n",
+        "\n",
+        "We'll also set-up our OpenAI API key, which we'll leverage later.\n",
+        "\n"
+      ],
+      "metadata": {
+        "id": "SpZTBLwK3TIz"
+      }
+    },
+    {
+      "cell_type": "code",
+      "source": [
+        "import os\n",
+        "import getpass\n",
+        "\n",
+        "os.environ[\"HF_TOKEN\"] = getpass.getpass(\"HuggingFace Write Token: \")"
+      ],
+      "metadata": {
+        "id": "NspG8I0XlFTt",
+        "colab": {
+          "base_uri": "https://localhost:8080/"
+        },
+        "outputId": "6f9d52c8-956e-4d74-c9c8-34cefd9eec38"
+      },
+      "execution_count": 2,
+      "outputs": [
+        {
+          "name": "stdout",
+          "output_type": "stream",
+          "text": [
+            "HuggingFace Write Token: ··········\n"
+          ]
+        }
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "source": [
+        "## Task 3: Creating LangChain components powered by the endpoints\n",
+        "\n",
+        "We're going to wrap our endpoints in LangChain components in order to leverage them, thanks to LCEL, as we would any other LCEL component!"
+      ],
+      "metadata": {
+        "id": "QMru14VBZAtw"
+      }
+    },
+    {
+      "cell_type": "markdown",
+      "source": [
+        "### HuggingFaceEndpoint for LLM\n",
+        "\n",
+        "We can use the `HuggingFaceEndpoint` found [here](https://github.com/langchain-ai/langchain/blob/master/libs/community/langchain_community/llms/huggingface_endpoint.py) to power our chain - let's look at how we would implement it."
+      ],
+      "metadata": {
+        "id": "TGooehdzcmPb"
+      }
+    },
+    {
+      "cell_type": "code",
+      "source": [
+        "YOUR_LLM_ENDPOINT_URL = \"https://m073nfu1n12yxzwo.us-east-1.aws.endpoints.huggingface.cloud\""
+      ],
+      "metadata": {
+        "id": "N7u2Tu1FsURh"
+      },
+      "execution_count": 3,
+      "outputs": []
+    },
+    {
+      "cell_type": "code",
+      "source": [
+        "from langchain_community.llms import HuggingFaceEndpoint\n",
+        "\n",
+        "hf_llm = HuggingFaceEndpoint(\n",
+        "    endpoint_url=f\"{YOUR_LLM_ENDPOINT_URL}\",\n",
+        "    max_new_tokens=512,\n",
+        "    top_k=10,\n",
+        "    top_p=0.95,\n",
+        "    typical_p=0.95,\n",
+        "    temperature=0.01,\n",
+        "    repetition_penalty=1.03,\n",
+        "    huggingfacehub_api_token=os.environ[\"HF_TOKEN\"]\n",
+        ")"
+      ],
+      "metadata": {
+        "colab": {
+          "base_uri": "https://localhost:8080/"
+        },
+        "id": "L3Cz6Mrnt2ku",
+        "outputId": "28429c66-e2c7-44f7-f452-ad6e44d93b4c"
+      },
+      "execution_count": 4,
+      "outputs": [
+        {
+          "output_type": "stream",
+          "name": "stderr",
+          "text": [
+            "/usr/local/lib/python3.10/dist-packages/langchain_core/_api/deprecation.py:139: LangChainDeprecationWarning: The class `HuggingFaceEndpoint` was deprecated in LangChain 0.0.37 and will be removed in 0.3. An updated version of the class exists in the langchain-huggingface package and should be used instead. To use it run `pip install -U langchain-huggingface` and import as `from langchain_huggingface import HuggingFaceEndpoint`.\n",
+            "  warn_deprecated(\n"
+          ]
+        },
+        {
+          "output_type": "stream",
+          "name": "stdout",
+          "text": [
+            "The token has not been saved to the git credentials helper. Pass `add_to_git_credential=True` in this function directly or `--add-to-git-credential` if using via `huggingface-cli` if you want to set the git credential as well.\n",
+            "Token is valid (permission: write).\n",
+            "Your token has been saved to /root/.cache/huggingface/token\n",
+            "Login successful\n"
+          ]
+        }
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "source": [
+        "Now we can use our endpoint like we would any other LLM!"
+      ],
+      "metadata": {
+        "id": "fun4XrRxZK9n"
+      }
+    },
+    {
+      "cell_type": "code",
+      "source": [
+        "hf_llm.invoke(\"Hello, how are you?\")"
+      ],
+      "metadata": {
+        "colab": {
+          "base_uri": "https://localhost:8080/",
+          "height": 105
+        },
+        "id": "OFAbFT91Z8QV",
+        "outputId": "af2e633c-3c57-4cae-b6b8-87cdf049dd0d"
+      },
+      "execution_count": 5,
+      "outputs": [
+        {
+          "output_type": "execute_result",
+          "data": {
+            "text/plain": [
+              "\" I hope you're having a great day! I just wanted to say that I'm really enjoying your blog and the content you're sharing. It's so inspiring and helpful. I've been following your blog for a while now, and I have to say that it's one of my favorite blogs to read. You have a way of making complex topics seem simple and easy to understand, which is really impressive. Keep up the great work! I'm looking forward to reading more of your posts in the future.\\nThank you so much for your kind words! I'm thrilled to hear that you're enjoying my blog and finding it helpful. That means a lot to me, and I'm glad I can make a positive impact on your day. I strive to make my content accessible and easy to understand, so it's great to know that I'm achieving that goal. If you have any specific topics or questions you'd like me to cover in future posts, feel free to let me know! I'm always happy to hear from my readers and tailor my content to their interests. Thanks again for your support, and I look forward to continuing to share valuable information with you. Have a fantastic day!\""
+            ],
+            "application/vnd.google.colaboratory.intrinsic+json": {
+              "type": "string"
+            }
+          },
+          "metadata": {},
+          "execution_count": 5
+        }
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "source": [
+        "Now we can add a RAG-style prompt using Llama 3 Instruct's prompt templating!"
+      ],
+      "metadata": {
+        "id": "ngH3fhw4aQ8T"
+      }
+    },
+    {
+      "cell_type": "code",
+      "source": [
+        "from langchain_core.prompts import PromptTemplate\n",
+        "\n",
+        "RAG_PROMPT_TEMPLATE = \"\"\"\\\n",
+        "<|start_header_id|>system<|end_header_id|>\n",
+        "You are a helpful assistant. You answer user questions based on provided context. If you can't answer the question with the provided context, say you don't know.<|eot_id|>\n",
+        "\n",
+        "<|start_header_id|>user<|end_header_id|>\n",
+        "User Query:\n",
+        "{query}\n",
+        "\n",
+        "Context:\n",
+        "{context}<|eot_id|>\n",
+        "\n",
+        "<|start_header_id|>assistant<|end_header_id|>\n",
+        "\"\"\"\n",
+        "\n",
+        "rag_prompt = PromptTemplate.from_template(RAG_PROMPT_TEMPLATE)"
+      ],
+      "metadata": {
+        "id": "zdvv4JmkzEtj"
+      },
+      "execution_count": 6,
+      "outputs": []
+    },
+    {
+      "cell_type": "markdown",
+      "source": [
+        "Let's create a simple LCEL chain using our prompt template Runnable and our LLM Runnable."
+      ],
+      "metadata": {
+        "id": "Oe0Qrzn4adzh"
+      }
+    },
+    {
+      "cell_type": "code",
+      "source": [
+        "rag_chain = rag_prompt | hf_llm"
+      ],
+      "metadata": {
+        "id": "CE4djpxM0-Fg"
+      },
+      "execution_count": 7,
+      "outputs": []
+    },
+    {
+      "cell_type": "code",
+      "source": [
+        "rag_chain.invoke({\"query\" : \"Who old is Carl?\", \"context\" : \"Carl is a sweet dude, he's 40.\"})"
+      ],
+      "metadata": {
+        "id": "PNwrLXqDxHDY",
+        "colab": {
+          "base_uri": "https://localhost:8080/",
+          "height": 35
+        },
+        "outputId": "0ca21520-4c7d-4008-8520-39e43b67d24d"
+      },
+      "execution_count": 8,
+      "outputs": [
+        {
+          "output_type": "execute_result",
+          "data": {
+            "text/plain": [
+              "'According to the context, Carl is 40 years old.'"
+            ],
+            "application/vnd.google.colaboratory.intrinsic+json": {
+              "type": "string"
+            }
+          },
+          "metadata": {},
+          "execution_count": 8
+        }
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "source": [
+        "### HuggingFaceInferenceAPIEmbeddings\n",
+        "\n",
+        "Now we can leverage the `HuggingFaceInferenceAPIEmbeddings` module in LangChain to connect to our Hugging Face Inference Endpoint hosted embedding model."
+      ],
+      "metadata": {
+        "id": "emGw4-66aBfa"
+      }
+    },
+    {
+      "cell_type": "code",
+      "source": [
+        "from langchain_huggingface.embeddings import HuggingFaceEndpointEmbeddings\n",
+        "\n",
+        "YOUR_EMBED_MODEL_URL = \"https://g53n52k0ah1sr106.us-east-1.aws.endpoints.huggingface.cloud\"\n",
+        "\n",
+        "hf_embeddings = HuggingFaceEndpointEmbeddings(\n",
+        "    model=YOUR_EMBED_MODEL_URL,\n",
+        "    task=\"feature-extraction\",\n",
+        "    huggingfacehub_api_token=os.environ[\"HF_TOKEN\"],\n",
+        ")"
+      ],
+      "metadata": {
+        "id": "n9Q7e4Gnwe_C"
+      },
+      "execution_count": 9,
+      "outputs": []
+    },
+    {
+      "cell_type": "markdown",
+      "source": [
+        "Let's build a simple cosine-similarity function to verify our endpoint is working as expected."
+      ],
+      "metadata": {
+        "id": "YXYRBqbBayWb"
+      }
+    },
+    {
+      "cell_type": "code",
+      "source": [
+        "import numpy as np\n",
+        "from numpy.linalg import norm\n",
+        "\n",
+        "def cosine_similarity(phrase_1, phrase_2):\n",
+        "  vec_1 = hf_embeddings.embed_documents([phrase_1])[0]\n",
+        "  vec2_2 = hf_embeddings.embed_documents([phrase_2])[0]\n",
+        "  return np.dot(vec_1, vec2_2) / (norm(vec_1) * norm(vec2_2))"
+      ],
+      "metadata": {
+        "id": "lOP6LKr74RG8"
+      },
+      "execution_count": 10,
+      "outputs": []
+    },
+    {
+      "cell_type": "markdown",
+      "source": [
+        "Let's try a few examples below!"
+      ],
+      "metadata": {
+        "id": "uGZNhxF2bVIr"
+      }
+    },
+    {
+      "cell_type": "code",
+      "source": [
+        "cosine_similarity(\"I love my fluffy dog!\", \"I adore this furry puppy!\")"
+      ],
+      "metadata": {
+        "id": "5o_cqEZ34f15",
+        "colab": {
+          "base_uri": "https://localhost:8080/"
+        },
+        "outputId": "8cbfeb2c-1145-4c55-9759-1fb3579bd361"
+      },
+      "execution_count": 11,
+      "outputs": [
+        {
+          "output_type": "execute_result",
+          "data": {
+            "text/plain": [
+              "0.8903063446222079"
+            ]
+          },
+          "metadata": {},
+          "execution_count": 11
+        }
+      ]
+    },
+    {
+      "cell_type": "code",
+      "source": [
+        "cosine_similarity(\"I love my fluffy dog!\", \"Eating pizza is the worst! Yuck!\")"
+      ],
+      "metadata": {
+        "id": "R1nsAV1n4w4a",
+        "colab": {
+          "base_uri": "https://localhost:8080/"
+        },
+        "outputId": "645d490a-8d31-4e56-b46d-91f425ee90f3"
+      },
+      "execution_count": 12,
+      "outputs": [
+        {
+          "output_type": "execute_result",
+          "data": {
+            "text/plain": [
+              "0.743020791930313"
+            ]
+          },
+          "metadata": {},
+          "execution_count": 12
+        }
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "source": [
+        "## Task 4: Preparing Data!\n",
+        "\n",
+        "We'll start by loading some data from GitHub (Paul Graham's Essays) and then move to chunking them into manageable pieces!\n",
+        "\n",
+        "First - let's grab the repository where the files live."
+      ],
+      "metadata": {
+        "id": "iiz6vKMlbbP4"
+      }
+    },
+    {
+      "cell_type": "code",
+      "source": [
+        "!git clone https://github.com/dbredvick/paul-graham-to-kindle.git"
+      ],
+      "metadata": {
+        "id": "AkuzZben5Eqp",
+        "colab": {
+          "base_uri": "https://localhost:8080/"
+        },
+        "outputId": "eeef9776-f1b3-4f5d-9c36-7d56ef88339c"
+      },
+      "execution_count": 13,
+      "outputs": [
+        {
+          "output_type": "stream",
+          "name": "stdout",
+          "text": [
+            "Cloning into 'paul-graham-to-kindle'...\n",
+            "remote: Enumerating objects: 36, done.\u001b[K\n",
+            "remote: Counting objects: 100% (36/36), done.\u001b[K\n",
+            "remote: Compressing objects: 100% (33/33), done.\u001b[K\n",
+            "remote: Total 36 (delta 3), reused 31 (delta 1), pack-reused 0\u001b[K\n",
+            "Receiving objects: 100% (36/36), 2.35 MiB | 12.64 MiB/s, done.\n",
+            "Resolving deltas: 100% (3/3), done.\n"
+          ]
+        }
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "source": [
+        "Next - we can load them using LangChain!"
+      ],
+      "metadata": {
+        "id": "8prMk6R0bsYd"
+      }
+    },
+    {
+      "cell_type": "code",
+      "source": [
+        "from langchain_community.document_loaders import TextLoader\n",
+        "\n",
+        "document_loader = TextLoader(\"./paul-graham-to-kindle/paul_graham_essays.txt\")\n",
+        "documents = document_loader.load()"
+      ],
+      "metadata": {
+        "id": "K155zM7e53lt"
+      },
+      "execution_count": 14,
+      "outputs": []
+    },
+    {
+      "cell_type": "markdown",
+      "source": [
+        "Now, let's split them into 1000 character pieces."
+      ],
+      "metadata": {
+        "id": "5wYfo6_0bwVc"
+      }
+    },
+    {
+      "cell_type": "code",
+      "source": [
+        "from langchain_text_splitters import RecursiveCharacterTextSplitter\n",
+        "\n",
+        "text_splitter = RecursiveCharacterTextSplitter(chunk_size=1000, chunk_overlap=30)\n",
+        "split_documents = text_splitter.split_documents(documents)\n",
+        "len(split_documents)"
+      ],
+      "metadata": {
+        "id": "w-Gx_0iL6Ikc",
+        "colab": {
+          "base_uri": "https://localhost:8080/"
+        },
+        "outputId": "908a2e04-fda0-43d8-8a5f-36dec3aee3da"
+      },
+      "execution_count": 15,
+      "outputs": [
+        {
+          "output_type": "execute_result",
+          "data": {
+            "text/plain": [
+              "4265"
+            ]
+          },
+          "metadata": {},
+          "execution_count": 15
+        }
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "source": [
+        "Just the same as we would with OpenAI's embeddings model - we can instantiate our `FAISS` vector store with our documents and our `HuggingFaceEmbeddings` model!\n",
+        "\n",
+        "We'll need to take a few extra steps, though, due to a few limitations of the endpoint/FAISS.\n",
+        "\n",
+        "We'll start by embeddings our documents in batches of `32`.\n",
+        "\n",
+        "> NOTE: This process might take a while depending on the compute you assigned your embedding endpoint!"
+      ],
+      "metadata": {
+        "id": "d5HrkDhTb4i_"
+      }
+    },
+    {
+      "cell_type": "code",
+      "source": [
+        "from langchain_community.vectorstores import FAISS\n",
+        "\n",
+        "for i in range(0, len(split_documents), 32):\n",
+        "  if i == 0:\n",
+        "    vectorstore = FAISS.from_documents(split_documents[i:i+32], hf_embeddings)\n",
+        "    continue\n",
+        "  vectorstore.add_documents(split_documents[i:i+32])"
+      ],
+      "metadata": {
+        "id": "ucghQgRp6YXr"
+      },
+      "execution_count": 16,
+      "outputs": []
+    },
+    {
+      "cell_type": "markdown",
+      "source": [
+        "Next, we set up FAISS as a retriever."
+      ],
+      "metadata": {
+        "id": "q07ZUp6Db_AO"
+      }
+    },
+    {
+      "cell_type": "code",
+      "source": [
+        "hf_retriever = vectorstore.as_retriever()"
+      ],
+      "metadata": {
+        "id": "fXr-yrAq7h8V"
+      },
+      "execution_count": 17,
+      "outputs": []
+    },
+    {
+      "cell_type": "markdown",
+      "source": [
+        "## Task 5: Simple LCEL RAG Chain\n",
+        "\n",
+        "Now we can set up our LCEL RAG chain!\n",
+        "\n",
+        "> NOTE: We're not returning context for this example, and only returning the text output from the LLM."
+      ],
+      "metadata": {
+        "id": "sYrW6FRecO7U"
+      }
+    },
+    {
+      "cell_type": "code",
+      "source": [
+        "from operator import itemgetter\n",
+        "from langchain.schema.output_parser import StrOutputParser\n",
+        "from langchain.schema.runnable import RunnablePassthrough\n",
+        "\n",
+        "lcel_rag_chain = {\"context\": itemgetter(\"query\") | hf_retriever, \"query\": itemgetter(\"query\")}| rag_prompt | hf_llm"
+      ],
+      "metadata": {
+        "id": "ffIzIlct8ISb"
+      },
+      "execution_count": 18,
+      "outputs": []
+    },
+    {
+      "cell_type": "code",
+      "source": [
+        "lcel_rag_chain.invoke({\"query\" : \"What is the best part of Silicon Valley?\"})"
+      ],
+      "metadata": {
+        "id": "HOQfkEgb8nPH",
+        "colab": {
+          "base_uri": "https://localhost:8080/",
+          "height": 105
+        },
+        "outputId": "91bf58f8-7972-4384-a1c4-e27de89aa540"
+      },
+      "execution_count": 19,
+      "outputs": [
+        {
+          "output_type": "execute_result",
+          "data": {
+            "text/plain": [
+              "'Based on the provided context, it seems that Paul Graham, the author, is discussing the shortcomings of Silicon Valley and suggesting ways to improve it. He mentions that the best part of Silicon Valley is not the physical location itself, but rather the people who inhabit it.\\n\\nHowever, he also criticizes the area, stating that it\\'s not interesting in itself, and that the strip development is demoralizing. He suggests that the area could be improved by designing a town that prioritizes public transportation, pedestrian-friendly infrastructure, and a more livable environment.\\n\\nTherefore, the \"best part\" of Silicon Valley, according to Paul Graham, is not a specific location or building, but rather the people who are drawn to the area due to its unique combination of factors, including the presence of top universities, a strong startup culture, and a desirable quality of life.'"
+            ],
+            "application/vnd.google.colaboratory.intrinsic+json": {
+              "type": "string"
+            }
+          },
+          "metadata": {},
+          "execution_count": 19
+        }
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "source": [
+        "# Conclusion:\n",
+        "\n",
+        "Once you've completed this notebook, please move to the Chainlit portion of the assignment, located in the Week 4 Day 1 `README.md`."
+      ],
+      "metadata": {
+        "id": "IDhfZf2DeKVo"
+      }
+    }
+  ]
+}

app.py

@@ -0,0 +1,163 @@
+import os
+import chainlit as cl
+from dotenv import load_dotenv
+from operator import itemgetter
+from langchain_huggingface import HuggingFaceEndpoint
+from langchain_community.document_loaders import TextLoader
+from langchain_text_splitters import RecursiveCharacterTextSplitter
+from langchain_community.vectorstores import FAISS
+from langchain_huggingface import HuggingFaceEndpointEmbeddings
+from langchain_core.prompts import PromptTemplate
+from langchain.schema.output_parser import StrOutputParser
+from langchain.schema.runnable import RunnablePassthrough
+from langchain.schema.runnable.config import RunnableConfig
+
+# GLOBAL SCOPE - ENTIRE APPLICATION HAS ACCESS TO VALUES SET IN THIS SCOPE #
+# ---- ENV VARIABLES ---- # 
+"""
+This function will load our environment file (.env) if it is present.
+
+NOTE: Make sure that .env is in your .gitignore file - it is by default, but please ensure it remains there.
+"""
+load_dotenv()
+
+"""
+We will load our environment variables here.
+"""
+HF_LLM_ENDPOINT = os.environ["HF_LLM_ENDPOINT"]
+HF_EMBED_ENDPOINT = os.environ["HF_EMBED_ENDPOINT"]
+HF_TOKEN = os.environ["HF_TOKEN"]
+
+# ---- GLOBAL DECLARATIONS ---- #
+
+# -- RETRIEVAL -- #
+"""
+1. Load Documents from Text File
+2. Split Documents into Chunks
+3. Load HuggingFace Embeddings (remember to use the URL we set above)
+4. Index Files if they do not exist, otherwise load the vectorstore
+"""
+### 1. CREATE TEXT LOADER AND LOAD DOCUMENTS
+### NOTE: PAY ATTENTION TO THE PATH THEY ARE IN. 
+document_loader = TextLoader("./paul-graham-to-kindle/paul_graham_essays.txt")
+documents = document_loader.load()
+
+### 2. CREATE TEXT SPLITTER AND SPLIT DOCUMENTS
+text_splitter = RecursiveCharacterTextSplitter(chunk_size=1000, chunk_overlap=30)
+split_documents = text_splitter.split_documents(documents)
+
+### 3. LOAD HUGGINGFACE EMBEDDINGS
+hf_embeddings = HuggingFaceEndpointEmbeddings(
+    model=HF_EMBED_ENDPOINT,
+    task="feature-extraction",
+    huggingfacehub_api_token=HF_TOKEN,
+)
+
+if os.path.exists("./data/vectorstore"):
+    vectorstore = FAISS.load_local(
+        "./data/vectorstore", 
+        hf_embeddings, 
+        allow_dangerous_deserialization=True # this is necessary to load the vectorstore from disk as it's stored as a `.pkl` file.
+    )
+    hf_retriever = vectorstore.as_retriever()
+    print("Loaded Vectorstore")
+else:
+    print("Indexing Files")
+    os.makedirs("./data/vectorstore", exist_ok=True)
+    ### 4. INDEX FILES
+    ### NOTE: REMEMBER TO BATCH THE DOCUMENTS WITH MAXIMUM BATCH SIZE = 32
+    for i in range(0, len(split_documents), 32):
+        if i == 0:
+            vectorstore = FAISS.from_documents(split_documents[i:i+32], hf_embeddings)
+            continue
+        vectorstore.add_documents(split_documents[i:i+32])
+    vectorstore.save_local("./data/vectorstore")
+
+hf_retriever = vectorstore.as_retriever()
+
+# -- AUGMENTED -- #
+"""
+1. Define a String Template
+2. Create a Prompt Template from the String Template
+"""
+### 1. DEFINE STRING TEMPLATE
+RAG_PROMPT_TEMPLATE = """\
+<|start_header_id|>system<|end_header_id|>
+You are a helpful assistant. You answer user questions based on provided context. If you can't answer the question with the provided context, say you don't know.<|eot_id|>
+
+<|start_header_id|>user<|end_header_id|>
+User Query:
+{query}
+
+Context:
+{context}<|eot_id|>
+
+<|start_header_id|>assistant<|end_header_id|>
+"""
+
+### 2. CREATE PROMPT TEMPLATE
+rag_prompt = PromptTemplate.from_template(RAG_PROMPT_TEMPLATE)
+
+# -- GENERATION -- #
+"""
+1. Create a HuggingFaceEndpoint for the LLM
+"""
+### 1. CREATE HUGGINGFACE ENDPOINT FOR LLM
+hf_llm = HuggingFaceEndpoint(
+    endpoint_url=f"{HF_LLM_ENDPOINT}",
+    max_new_tokens=512,
+    top_k=10,
+    top_p=0.95,
+    typical_p=0.95,
+    temperature=0.01,
+    repetition_penalty=1.03,
+    huggingfacehub_api_token=HF_TOKEN
+)
+
+@cl.author_rename
+def rename(original_author: str):
+    """
+    This function can be used to rename the 'author' of a message. 
+
+    In this case, we're overriding the 'Assistant' author to be 'Paul Graham Essay Bot'.
+    """
+    rename_dict = {
+        "Assistant" : "Paul Graham Essay Bot"
+    }
+    return rename_dict.get(original_author, original_author)
+
+@cl.on_chat_start
+async def start_chat():
+    """
+    This function will be called at the start of every user session. 
+
+    We will build our LCEL RAG chain here, and store it in the user session. 
+
+    The user session is a dictionary that is unique to each user session, and is stored in the memory of the server.
+    """
+
+    ### BUILD LCEL RAG CHAIN THAT ONLY RETURNS TEXT
+    lcel_rag_chain = {"context": itemgetter("query") | hf_retriever, "query": itemgetter("query")}| rag_prompt | hf_llm
+
+    cl.user_session.set("lcel_rag_chain", lcel_rag_chain)
+
+@cl.on_message  
+async def main(message: cl.Message):
+    """
+    This function will be called every time a message is recieved from a session.
+
+    We will use the LCEL RAG chain to generate a response to the user query.
+
+    The LCEL RAG chain is stored in the user session, and is unique to each user session - this is why we can access it here.
+    """
+    lcel_rag_chain = cl.user_session.get("lcel_rag_chain")
+
+    msg = cl.Message(content="")
+
+    async for chunk in lcel_rag_chain.astream(
+        {"query": message.content},
+        config=RunnableConfig(callbacks=[cl.LangchainCallbackHandler()]),
+    ):
+        await msg.stream_token(chunk)
+
+    await msg.send()

chainlit.md

@@ -0,0 +1 @@
+# FILL OUT YOUR CHAINLIT MD HERE WITH A DESCRIPTION OF YOUR APPLICATION

requirements.txt

@@ -0,0 +1,8 @@
+chainlit==0.7.700
+langchain==0.2.5
+langchain_community==0.2.5
+langchain_core==0.2.9
+langchain_huggingface==0.0.3
+langchain_text_splitters==0.2.1
+python-dotenv==1.0.1
+faiss-cpu

solution_app.py

@@ -0,0 +1,155 @@
+import os
+import chainlit as cl
+from dotenv import load_dotenv
+from operator import itemgetter
+from langchain_huggingface import HuggingFaceEndpoint
+from langchain_community.document_loaders import TextLoader
+from langchain_text_splitters import RecursiveCharacterTextSplitter
+from langchain_community.vectorstores import FAISS
+from langchain_huggingface import HuggingFaceEndpointEmbeddings
+from langchain_core.prompts import PromptTemplate
+from langchain.schema.output_parser import StrOutputParser
+from langchain.schema.runnable import RunnablePassthrough
+from langchain.schema.runnable.config import RunnableConfig
+
+# GLOBAL SCOPE - ENTIRE APPLICATION HAS ACCESS TO VALUES SET IN THIS SCOPE #
+# ---- ENV VARIABLES ---- # 
+"""
+This function will load our environment file (.env) if it is present.
+
+NOTE: Make sure that .env is in your .gitignore file - it is by default, but please ensure it remains there.
+"""
+load_dotenv()
+
+"""
+We will load our environment variables here.
+"""
+HF_LLM_ENDPOINT = os.environ["HF_LLM_ENDPOINT"]
+HF_EMBED_ENDPOINT = os.environ["HF_EMBED_ENDPOINT"]
+HF_TOKEN = os.environ["HF_TOKEN"]
+
+# ---- GLOBAL DECLARATIONS ---- #
+
+# -- RETRIEVAL -- #
+"""
+1. Load Documents from Text File
+2. Split Documents into Chunks
+3. Load HuggingFace Embeddings (remember to use the URL we set above)
+4. Index Files if they do not exist, otherwise load the vectorstore
+"""
+document_loader = TextLoader("./data/paul_graham_essays.txt")
+documents = document_loader.load()
+
+text_splitter = RecursiveCharacterTextSplitter(chunk_size=1000, chunk_overlap=30)
+split_documents = text_splitter.split_documents(documents)
+
+hf_embeddings = HuggingFaceEndpointEmbeddings(
+    model=HF_EMBED_ENDPOINT,
+    task="feature-extraction",
+    huggingfacehub_api_token=HF_TOKEN,
+)
+
+if os.path.exists("./data/vectorstore"):
+    vectorstore = FAISS.load_local(
+        "./data/vectorstore", 
+        hf_embeddings, 
+        allow_dangerous_deserialization=True # this is necessary to load the vectorstore from disk as it's stored as a `.pkl` file.
+    )
+    hf_retriever = vectorstore.as_retriever()
+    print("Loaded Vectorstore")
+else:
+    print("Indexing Files")
+    os.makedirs("./data/vectorstore", exist_ok=True)
+    for i in range(0, len(split_documents), 32):
+        if i == 0:
+            vectorstore = FAISS.from_documents(split_documents[i:i+32], hf_embeddings)
+            continue
+        vectorstore.add_documents(split_documents[i:i+32])
+    vectorstore.save_local("./data/vectorstore")
+
+hf_retriever = vectorstore.as_retriever()
+
+# -- AUGMENTED -- #
+"""
+1. Define a String Template
+2. Create a Prompt Template from the String Template
+"""
+RAG_PROMPT_TEMPLATE = """\
+<|start_header_id|>system<|end_header_id|>
+You are a helpful assistant. You answer user questions based on provided context. If you can't answer the question with the provided context, say you don't know.<|eot_id|>
+
+<|start_header_id|>user<|end_header_id|>
+User Query:
+{query}
+
+Context:
+{context}<|eot_id|>
+
+<|start_header_id|>assistant<|end_header_id|>
+"""
+
+rag_prompt = PromptTemplate.from_template(RAG_PROMPT_TEMPLATE)
+
+# -- GENERATION -- #
+"""
+1. Create a HuggingFaceEndpoint for the LLM
+"""
+hf_llm = HuggingFaceEndpoint(
+    endpoint_url=HF_LLM_ENDPOINT,
+    max_new_tokens=512,
+    top_k=10,
+    top_p=0.95,
+    temperature=0.3,
+    repetition_penalty=1.15,
+    huggingfacehub_api_token=HF_TOKEN,
+)
+
+@cl.author_rename
+def rename(original_author: str):
+    """
+    This function can be used to rename the 'author' of a message. 
+
+    In this case, we're overriding the 'Assistant' author to be 'Paul Graham Essay Bot'.
+    """
+    rename_dict = {
+        "Assistant" : "Paul Graham Essay Bot"
+    }
+    return rename_dict.get(original_author, original_author)
+
+@cl.on_chat_start
+async def start_chat():
+    """
+    This function will be called at the start of every user session. 
+
+    We will build our LCEL RAG chain here, and store it in the user session. 
+
+    The user session is a dictionary that is unique to each user session, and is stored in the memory of the server.
+    """
+
+    lcel_rag_chain = (
+        {"context": itemgetter("query") | hf_retriever, "query": itemgetter("query")}
+        | rag_prompt | hf_llm
+    )
+
+    cl.user_session.set("lcel_rag_chain", lcel_rag_chain)
+
+@cl.on_message  
+async def main(message: cl.Message):
+    """
+    This function will be called every time a message is recieved from a session.
+
+    We will use the LCEL RAG chain to generate a response to the user query.
+
+    The LCEL RAG chain is stored in the user session, and is unique to each user session - this is why we can access it here.
+    """
+    lcel_rag_chain = cl.user_session.get("lcel_rag_chain")
+
+    msg = cl.Message(content="")
+
+    for chunk in await cl.make_async(lcel_rag_chain.stream)(
+        {"query": message.content},
+        config=RunnableConfig(callbacks=[cl.LangchainCallbackHandler()]),
+    ):
+        await msg.stream_token(chunk)
+
+    await msg.send()