ai-engineering/example6.ipynb

{
  "nbformat": 4,
  "nbformat_minor": 0,
  "metadata": {
    "colab": {
      "provenance": []
    },
    "kernelspec": {
      "name": "python3",
      "display_name": "Python 3"
    },
    "language_info": {
      "name": "python"
    }
  },
  "cells": [
    {
      "cell_type": "markdown",
      "source": [
        "We've actually already seen how it can be useful to \"chain\" various LLM operations together. In the Hinglish chat example we chained a response generation and then a machine translation using LLMs.\n",
        "\n",
        "**As you solve problems with LLMs, do NOT always think about your task as a single prompt.** Decompose your problem into multiple steps. Just like programming which uses multiple functions, classes, etc. LLM integration is a new kind of reasoning engine that you can \"program\" in a multi-step, conditional, control flow sort of fashion.\n",
        "\n",
        "Further, enterprise LLM appllications need reliability, trust, and consistency. **Because LLMs only predict probable text, they have no understanding or connection to reality.** This produces **hallucinations** that can be part of a coherent text block but factually (or otherwise) wrong. To deal with this we need to **ground** on LLM operations with external data."
      ],
      "metadata": {
        "id": "xm6EIVbldZer"
      }
    },
    {
      "cell_type": "markdown",
      "source": [
        "# Dependencies and imports"
      ],
      "metadata": {
        "id": "wK6zNdTOdVcE"
      }
    },
    {
      "cell_type": "code",
      "execution_count": 1,
      "metadata": {
        "id": "I2yX1z4WyJP2",
        "colab": {
          "base_uri": "https://localhost:8080/"
        },
        "outputId": "fe70ca39-3357-447a-b2b0-110775831a97"
      },
      "outputs": [
        {
          "output_type": "stream",
          "name": "stdout",
          "text": [
            "Requirement already satisfied: langchain in /usr/local/lib/python3.10/dist-packages (0.3.7)\n",
            "Collecting predictionguard\n",
            "  Downloading predictionguard-2.7.0-py2.py3-none-any.whl.metadata (872 bytes)\n",
            "Collecting lancedb\n",
            "  Downloading lancedb-0.16.0-cp38-abi3-manylinux_2_28_x86_64.whl.metadata (4.8 kB)\n",
            "Collecting html2text\n",
            "  Downloading html2text-2024.2.26.tar.gz (56 kB)\n",
            "\u001b[2K     \u001b[90m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\u001b[0m \u001b[32m56.5/56.5 kB\u001b[0m \u001b[31m2.4 MB/s\u001b[0m eta \u001b[36m0:00:00\u001b[0m\n",
            "\u001b[?25h  Preparing metadata (setup.py) ... \u001b[?25l\u001b[?25hdone\n",
            "Requirement already satisfied: PyYAML>=5.3 in /usr/local/lib/python3.10/dist-packages (from langchain) (6.0.2)\n",
            "Requirement already satisfied: SQLAlchemy<3,>=1.4 in /usr/local/lib/python3.10/dist-packages (from langchain) (2.0.36)\n",
            "Requirement already satisfied: aiohttp<4.0.0,>=3.8.3 in /usr/local/lib/python3.10/dist-packages (from langchain) (3.11.2)\n",
            "Requirement already satisfied: async-timeout<5.0.0,>=4.0.0 in /usr/local/lib/python3.10/dist-packages (from langchain) (4.0.3)\n",
            "Requirement already satisfied: langchain-core<0.4.0,>=0.3.15 in /usr/local/lib/python3.10/dist-packages (from langchain) (0.3.19)\n",
            "Requirement already satisfied: langchain-text-splitters<0.4.0,>=0.3.0 in /usr/local/lib/python3.10/dist-packages (from langchain) (0.3.2)\n",
            "Requirement already satisfied: langsmith<0.2.0,>=0.1.17 in /usr/local/lib/python3.10/dist-packages (from langchain) (0.1.143)\n",
            "Requirement already satisfied: numpy<2,>=1 in /usr/local/lib/python3.10/dist-packages (from langchain) (1.26.4)\n",
            "Requirement already satisfied: pydantic<3.0.0,>=2.7.4 in /usr/local/lib/python3.10/dist-packages (from langchain) (2.9.2)\n",
            "Requirement already satisfied: requests<3,>=2 in /usr/local/lib/python3.10/dist-packages (from langchain) (2.32.3)\n",
            "Requirement already satisfied: tenacity!=8.4.0,<10,>=8.1.0 in /usr/local/lib/python3.10/dist-packages (from langchain) (9.0.0)\n",
            "Requirement already satisfied: tabulate>=0.8.10 in /usr/local/lib/python3.10/dist-packages (from predictionguard) (0.9.0)\n",
            "Collecting deprecation (from lancedb)\n",
            "  Downloading deprecation-2.1.0-py2.py3-none-any.whl.metadata (4.6 kB)\n",
            "Requirement already satisfied: nest-asyncio~=1.0 in /usr/local/lib/python3.10/dist-packages (from lancedb) (1.6.0)\n",
            "Collecting pylance==0.19.2 (from lancedb)\n",
            "  Downloading pylance-0.19.2-cp39-abi3-manylinux_2_28_x86_64.whl.metadata (7.4 kB)\n",
            "Requirement already satisfied: tqdm>=4.27.0 in /usr/local/lib/python3.10/dist-packages (from lancedb) (4.66.6)\n",
            "Requirement already satisfied: packaging in /usr/local/lib/python3.10/dist-packages (from lancedb) (24.2)\n",
            "Collecting overrides>=0.7 (from lancedb)\n",
            "  Downloading overrides-7.7.0-py3-none-any.whl.metadata (5.8 kB)\n",
            "Requirement already satisfied: pyarrow>=12 in /usr/local/lib/python3.10/dist-packages (from pylance==0.19.2->lancedb) (17.0.0)\n",
            "Requirement already satisfied: aiohappyeyeballs>=2.3.0 in /usr/local/lib/python3.10/dist-packages (from aiohttp<4.0.0,>=3.8.3->langchain) (2.4.3)\n",
            "Requirement already satisfied: aiosignal>=1.1.2 in /usr/local/lib/python3.10/dist-packages (from aiohttp<4.0.0,>=3.8.3->langchain) (1.3.1)\n",
            "Requirement already satisfied: attrs>=17.3.0 in /usr/local/lib/python3.10/dist-packages (from aiohttp<4.0.0,>=3.8.3->langchain) (24.2.0)\n",
            "Requirement already satisfied: frozenlist>=1.1.1 in /usr/local/lib/python3.10/dist-packages (from aiohttp<4.0.0,>=3.8.3->langchain) (1.5.0)\n",
            "Requirement already satisfied: multidict<7.0,>=4.5 in /usr/local/lib/python3.10/dist-packages (from aiohttp<4.0.0,>=3.8.3->langchain) (6.1.0)\n",
            "Requirement already satisfied: propcache>=0.2.0 in /usr/local/lib/python3.10/dist-packages (from aiohttp<4.0.0,>=3.8.3->langchain) (0.2.0)\n",
            "Requirement already satisfied: yarl<2.0,>=1.17.0 in /usr/local/lib/python3.10/dist-packages (from aiohttp<4.0.0,>=3.8.3->langchain) (1.17.2)\n",
            "Requirement already satisfied: jsonpatch<2.0,>=1.33 in /usr/local/lib/python3.10/dist-packages (from langchain-core<0.4.0,>=0.3.15->langchain) (1.33)\n",
            "Requirement already satisfied: typing-extensions>=4.7 in /usr/local/lib/python3.10/dist-packages (from langchain-core<0.4.0,>=0.3.15->langchain) (4.12.2)\n",
            "Requirement already satisfied: httpx<1,>=0.23.0 in /usr/local/lib/python3.10/dist-packages (from langsmith<0.2.0,>=0.1.17->langchain) (0.27.2)\n",
            "Requirement already satisfied: orjson<4.0.0,>=3.9.14 in /usr/local/lib/python3.10/dist-packages (from langsmith<0.2.0,>=0.1.17->langchain) (3.10.11)\n",
            "Requirement already satisfied: requests-toolbelt<2.0.0,>=1.0.0 in /usr/local/lib/python3.10/dist-packages (from langsmith<0.2.0,>=0.1.17->langchain) (1.0.0)\n",
            "Requirement already satisfied: annotated-types>=0.6.0 in /usr/local/lib/python3.10/dist-packages (from pydantic<3.0.0,>=2.7.4->langchain) (0.7.0)\n",
            "Requirement already satisfied: pydantic-core==2.23.4 in /usr/local/lib/python3.10/dist-packages (from pydantic<3.0.0,>=2.7.4->langchain) (2.23.4)\n",
            "Requirement already satisfied: charset-normalizer<4,>=2 in /usr/local/lib/python3.10/dist-packages (from requests<3,>=2->langchain) (3.4.0)\n",
            "Requirement already satisfied: idna<4,>=2.5 in /usr/local/lib/python3.10/dist-packages (from requests<3,>=2->langchain) (3.10)\n",
            "Requirement already satisfied: urllib3<3,>=1.21.1 in /usr/local/lib/python3.10/dist-packages (from requests<3,>=2->langchain) (2.2.3)\n",
            "Requirement already satisfied: certifi>=2017.4.17 in /usr/local/lib/python3.10/dist-packages (from requests<3,>=2->langchain) (2024.8.30)\n",
            "Requirement already satisfied: greenlet!=0.4.17 in /usr/local/lib/python3.10/dist-packages (from SQLAlchemy<3,>=1.4->langchain) (3.1.1)\n",
            "Requirement already satisfied: anyio in /usr/local/lib/python3.10/dist-packages (from httpx<1,>=0.23.0->langsmith<0.2.0,>=0.1.17->langchain) (3.7.1)\n",
            "Requirement already satisfied: httpcore==1.* in /usr/local/lib/python3.10/dist-packages (from httpx<1,>=0.23.0->langsmith<0.2.0,>=0.1.17->langchain) (1.0.7)\n",
            "Requirement already satisfied: sniffio in /usr/local/lib/python3.10/dist-packages (from httpx<1,>=0.23.0->langsmith<0.2.0,>=0.1.17->langchain) (1.3.1)\n",
            "Requirement already satisfied: h11<0.15,>=0.13 in /usr/local/lib/python3.10/dist-packages (from httpcore==1.*->httpx<1,>=0.23.0->langsmith<0.2.0,>=0.1.17->langchain) (0.14.0)\n",
            "Requirement already satisfied: jsonpointer>=1.9 in /usr/local/lib/python3.10/dist-packages (from jsonpatch<2.0,>=1.33->langchain-core<0.4.0,>=0.3.15->langchain) (3.0.0)\n",
            "Requirement already satisfied: exceptiongroup in /usr/local/lib/python3.10/dist-packages (from anyio->httpx<1,>=0.23.0->langsmith<0.2.0,>=0.1.17->langchain) (1.2.2)\n",
            "Downloading predictionguard-2.7.0-py2.py3-none-any.whl (21 kB)\n",
            "Downloading lancedb-0.16.0-cp38-abi3-manylinux_2_28_x86_64.whl (27.4 MB)\n",
            "\u001b[2K   \u001b[90m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\u001b[0m \u001b[32m27.4/27.4 MB\u001b[0m \u001b[31m19.6 MB/s\u001b[0m eta \u001b[36m0:00:00\u001b[0m\n",
            "\u001b[?25hDownloading pylance-0.19.2-cp39-abi3-manylinux_2_28_x86_64.whl (30.5 MB)\n",
            "\u001b[2K   \u001b[90m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\u001b[0m \u001b[32m30.5/30.5 MB\u001b[0m \u001b[31m14.9 MB/s\u001b[0m eta \u001b[36m0:00:00\u001b[0m\n",
            "\u001b[?25hDownloading overrides-7.7.0-py3-none-any.whl (17 kB)\n",
            "Downloading deprecation-2.1.0-py2.py3-none-any.whl (11 kB)\n",
            "Building wheels for collected packages: html2text\n",
            "  Building wheel for html2text (setup.py) ... \u001b[?25l\u001b[?25hdone\n",
            "  Created wheel for html2text: filename=html2text-2024.2.26-py3-none-any.whl size=33111 sha256=f87d69d5b3cabdda6a7c02a43a5110b158c37ea81d7c22dd2da57a1c8385d788\n",
            "  Stored in directory: /root/.cache/pip/wheels/f3/96/6d/a7eba8f80d31cbd188a2787b81514d82fc5ae6943c44777659\n",
            "Successfully built html2text\n",
            "Installing collected packages: overrides, html2text, deprecation, pylance, predictionguard, lancedb\n",
            "Successfully installed deprecation-2.1.0 html2text-2024.2.26 lancedb-0.16.0 overrides-7.7.0 predictionguard-2.7.0 pylance-0.19.2\n"
          ]
        }
      ],
      "source": [
        "! pip install langchain predictionguard lancedb html2text"
      ]
    },
    {
      "cell_type": "code",
      "source": [
        "import os\n",
        "import urllib.request\n",
        "import shutil\n",
        "\n",
        "import html2text\n",
        "from predictionguard import PredictionGuard\n",
        "from langchain import PromptTemplate, FewShotPromptTemplate\n",
        "from langchain.text_splitter import CharacterTextSplitter\n",
        "import numpy as np\n",
        "from getpass import getpass\n",
        "import lancedb\n",
        "import pandas as pd"
      ],
      "metadata": {
        "id": "Go5vRQcTycUl"
      },
      "execution_count": 2,
      "outputs": []
    },
    {
      "cell_type": "code",
      "source": [
        "pg_access_token = getpass('Enter your Prediction Guard access api key: ')\n",
        "os.environ['PREDICTIONGUARD_API_KEY'] = pg_access_token"
      ],
      "metadata": {
        "id": "HdSloPn7JTu0",
        "colab": {
          "base_uri": "https://localhost:8080/"
        },
        "outputId": "abb67ea8-7c90-4899-e8d5-8a553cb97ffd"
      },
      "execution_count": 3,
      "outputs": [
        {
          "name": "stdout",
          "output_type": "stream",
          "text": [
            "Enter your Prediction Guard access api key: ··········\n"
          ]
        }
      ]
    },
    {
      "cell_type": "code",
      "source": [
        "client = PredictionGuard()"
      ],
      "metadata": {
        "id": "_vXUaOF_DTaL"
      },
      "execution_count": 4,
      "outputs": []
    },
    {
      "cell_type": "markdown",
      "source": [
        "# Chaining"
      ],
      "metadata": {
        "id": "eTH1n7VuNm5g"
      }
    },
    {
      "cell_type": "code",
      "source": [
        "messages = [\n",
        "    {\n",
        "        \"role\": \"system\",\n",
        "        \"content\": \"\"\"Decide if the following input message is an informational question, a general chat message, or a request for code generation.\n",
        "If the message is an informational question, answer it based on the informational context provided below.\n",
        "If the message is a general chat message, respond in a kind and friendly manner based on the coversation context provided below.\n",
        "If the message is a request for code generation, respond with a code snippet.\n",
        "\n",
        "Informational Context: The Greater Los Angeles and San Francisco Bay areas in California are the nation's second and fifth-most populous urban regions, respectively. Greater Los Angeles has over 18.7 million residents and the San Francisco Bay Area has over 9.6 million residents. Los Angeles is state's most populous city and the nation's second-most populous city. San Francisco is the second-most densely populated major city in the country. Los Angeles County is the country's most populous county, and San Bernardino County is the nation's largest county by area. Sacramento is the state's capital.\"\"\",\n",
        "    },\n",
        "    {\n",
        "        \"role\": \"user\",\n",
        "        \"content\": \"Hello, how are you?\"\n",
        "    },\n",
        "    {\n",
        "        \"role\": \"assistant\",\n",
        "        \"content\": \"I'm good, what can I help you with?\"\n",
        "    },\n",
        "    {\n",
        "        \"role\": \"user\",\n",
        "        \"content\": \"What is the captital of California?\"\n",
        "    },\n",
        "    {\n",
        "        \"role\": \"assistant\",\n",
        "        \"content\": \"Sacramento\"\n",
        "    },\n",
        "    {\n",
        "        \"role\": \"user\",\n",
        "        \"content\": \"Thanks!\"\n",
        "    },\n",
        "    {\n",
        "        \"role\": \"assistant\",\n",
        "        \"content\": \"You are welcome!\"\n",
        "    }\n",
        "]"
      ],
      "metadata": {
        "id": "wiWYZO_xNr7q"
      },
      "execution_count": 13,
      "outputs": []
    },
    {
      "cell_type": "code",
      "source": [
        "messages.append({\n",
        "    \"role\": \"user\",\n",
        "    \"content\": \"What is the population of LA?\"\n",
        "})\n",
        "\n",
        "result = client.chat.completions.create(\n",
        "    model=\"Hermes-3-Llama-3.1-8B\",\n",
        "    messages=messages\n",
        ")\n",
        "\n",
        "print(result['choices'][0]['message']['content'])"
      ],
      "metadata": {
        "id": "bpXQfN0uk59t",
        "colab": {
          "base_uri": "https://localhost:8080/"
        },
        "outputId": "7ab171b2-741c-4dca-800f-db567dfeafab"
      },
      "execution_count": 14,
      "outputs": [
        {
          "output_type": "stream",
          "name": "stdout",
          "text": [
            "Greater Los Angeles, the second most populous urban region in the United States, has over 18.7 million residents. Los Angeles itself is the nation's second-most populous city.\n"
          ]
        }
      ]
    },
    {
      "cell_type": "code",
      "source": [
        "category_template = \"\"\"Read the below input and determine if it is a request to generate computer code? Respond \"yes\" or \"no\" and no other text.\n",
        "\n",
        "Input: \"{query}\"\n",
        "\n",
        "Response: \"\"\"\n",
        "\n",
        "category_prompt = PromptTemplate(\n",
        "    input_variables=[\"query\"],\n",
        "    template=category_template\n",
        ")\n",
        "\n",
        "qa_template = \"\"\"Context: {context}\n",
        "\n",
        "Question: {query}\n",
        "\n",
        "Answer: \"\"\"\n",
        "\n",
        "qa_prompt = PromptTemplate(\n",
        "    input_variables=[\"context\", \"query\"],\n",
        "    template=qa_template\n",
        ")\n",
        "\n",
        "qa_system = \"Read the context below and respond with an answer to the question. If the question cannot be answered based on the context alone or the context does not explicitly say the answer to the question, write \\\"Sorry I had trouble answering this question, based on the information I found.\\\"\"\n",
        "chat_system = \"You are a friendly and clever AI assistant. Respond to the latest human message in the input conversation below.\"\n",
        "code_system = \"You are a code generation assistant. Respond with a code snippet and any explanation requested in the below input.\"\n",
        "\n",
        "# QuestionID provides some help in determining if a sentence is a question.\n",
        "class QuestionID:\n",
        "    \"\"\"\n",
        "        QuestionID has the actual logic used to determine if sentence is a question\n",
        "    \"\"\"\n",
        "    def padCharacter(self, character: str, sentence: str):\n",
        "        if character in sentence:\n",
        "            position = sentence.index(character)\n",
        "            if position > 0 and position < len(sentence):\n",
        "\n",
        "                # Check for existing white space before the special character.\n",
        "                if (sentence[position - 1]) != \" \":\n",
        "                    sentence = sentence.replace(character, (\" \" + character))\n",
        "\n",
        "        return sentence\n",
        "\n",
        "    def predict(self, sentence: str):\n",
        "        questionStarters = [\n",
        "            \"which\", \"wont\", \"cant\", \"isnt\", \"arent\", \"is\", \"do\", \"does\",\n",
        "            \"will\", \"can\"\n",
        "        ]\n",
        "        questionElements = [\n",
        "            \"who\", \"what\", \"when\", \"where\", \"why\", \"how\", \"sup\", \"?\"\n",
        "        ]\n",
        "\n",
        "        sentence = sentence.lower()\n",
        "        sentence = sentence.replace(\"\\'\", \"\")\n",
        "        sentence = self.padCharacter('?', sentence)\n",
        "        splitWords = sentence.split()\n",
        "\n",
        "        if any(word == splitWords[0] for word in questionStarters) or any(\n",
        "                word in splitWords for word in questionElements):\n",
        "            return True\n",
        "        else:\n",
        "            return False\n",
        "\n",
        "def response_chain(message, message_history, info_context):\n",
        "\n",
        "  # Determine what kind of message this is.\n",
        "  result = client.chat.completions.create(\n",
        "      model=\"Hermes-3-Llama-3.1-8B\",\n",
        "      messages=[{\"role\": \"user\", \"content\": category_prompt.format(query=message)}]\n",
        "  )\n",
        "\n",
        "  # configure our chain\n",
        "  if \"yes\" in result['choices'][0]['message']['content']:\n",
        "    code = \"yes\"\n",
        "  else:\n",
        "    code = \"no\"\n",
        "  qIDModel = QuestionID()\n",
        "  question = qIDModel.predict(message)\n",
        "\n",
        "  if code == \"no\" and question:\n",
        "\n",
        "    # Handle the informational request.\n",
        "    result = client.chat.completions.create(\n",
        "        model=\"Hermes-3-Llama-3.1-8B\",\n",
        "        messages=[\n",
        "            {\n",
        "                \"role\": \"system\",\n",
        "                \"content\": qa_system\n",
        "            },\n",
        "            {\n",
        "                \"role\": \"user\",\n",
        "                \"content\": qa_prompt.format(context=info_context, query=message)\n",
        "            }\n",
        "        ]\n",
        "    )\n",
        "    completion = result['choices'][0]['message']['content']\n",
        "\n",
        "  elif code == \"yes\":\n",
        "\n",
        "    # Handle the code generation request.\n",
        "    result = client.chat.completions.create(\n",
        "        model=\"Hermes-3-Llama-3.1-8B\",\n",
        "        messages=[\n",
        "            {\n",
        "                \"role\": \"system\",\n",
        "                \"content\": code_system\n",
        "            },\n",
        "            {\n",
        "                \"role\": \"user\",\n",
        "                \"content\": message\n",
        "            }\n",
        "        ],\n",
        "        max_tokens=2000\n",
        "    )\n",
        "    completion = result['choices'][0]['message']['content']\n",
        "\n",
        "  else:\n",
        "\n",
        "    messages_use = [\n",
        "        {\n",
        "            \"role\": \"system\",\n",
        "            \"content\": chat_system\n",
        "        }\n",
        "    ]\n",
        "    messages_use += message_history\n",
        "    messages_use.append({\n",
        "        \"role\": \"user\",\n",
        "        \"content\": message\n",
        "    })\n",
        "\n",
        "    # Handle the chat message.\n",
        "    result = client.chat.completions.create(\n",
        "        model=\"Hermes-3-Llama-3.1-8B\",\n",
        "        messages=messages_use,\n",
        "        output={\n",
        "            \"toxicity\": True\n",
        "        }\n",
        "    )\n",
        "    completion = result['choices'][0]['message']['content']\n",
        "\n",
        "  return code, question, completion\n"
      ],
      "metadata": {
        "id": "82oTOlF6l0-S"
      },
      "execution_count": 21,
      "outputs": []
    },
    {
      "cell_type": "code",
      "source": [
        "info_context = \"The Greater Los Angeles and San Francisco Bay areas in California are the nation's second and fifth-most populous urban regions, respectively. Greater Los Angeles has over 18.7 million residents and the San Francisco Bay Area has over 9.6 million residents. Los Angeles is state's most populous city and the nation's second-most populous city. San Francisco is the second-most densely populated major city in the country. Los Angeles County is the country's most populous county, and San Bernardino County is the nation's largest county by area. Sacramento is the state's capital.\"\n",
        "\n",
        "convo_context = [\n",
        "    {\n",
        "        \"role\": \"user\",\n",
        "        \"content\": \"Hello, how are you?\"\n",
        "    },\n",
        "    {\n",
        "        \"role\": \"assistant\",\n",
        "        \"content\": \"I'm good, what can I help you with?\"\n",
        "    },\n",
        "    {\n",
        "        \"role\": \"user\",\n",
        "        \"content\": \"What is the captital of California?\"\n",
        "    },\n",
        "    {\n",
        "        \"role\": \"assistant\",\n",
        "        \"content\": \"Sacramento\"\n",
        "    },\n",
        "    {\n",
        "        \"role\": \"user\",\n",
        "        \"content\": \"Thanks!\"\n",
        "    },\n",
        "    {\n",
        "        \"role\": \"assistant\",\n",
        "        \"content\": \"You are welcome!\"\n",
        "    }\n",
        "]\n",
        "\n",
        "#message = \"Which city in California has the highest population?\"\n",
        "#message = \"I'm really enjoying this conversation.\"\n",
        "message = \"Generate some python code that gets the current weather in the bay area.\"\n",
        "\n",
        "code, question, completion = response_chain(message, convo_context, info_context)\n",
        "print(\"CODE GEN REQUESTED:\", code)\n",
        "print(\"QUESTION:\", question)\n",
        "print(\"\")\n",
        "print(\"RESPONSE:\", completion)"
      ],
      "metadata": {
        "id": "yWM2HeVNpFNz",
        "colab": {
          "base_uri": "https://localhost:8080/"
        },
        "outputId": "668ab5b6-e819-40ef-a69b-0745912a2f4f"
      },
      "execution_count": 22,
      "outputs": [
        {
          "output_type": "stream",
          "name": "stdout",
          "text": [
            "CODE GEN REQUESTED: yes\n",
            "QUESTION: False\n",
            "\n",
            "RESPONSE: Here's a Python code snippet that retrieves the current weather in the Bay Area using the OpenWeatherMap API:\n",
            "\n",
            "```python\n",
            "import requests\n",
            "\n",
            "def get_current_weather(location):\n",
            "    api_key = \"YOUR_API_KEY\"  # Replace with your OpenWeatherMap API key\n",
            "    base_url = \"http://api.openweathermap.org/data/2.5/weather\"\n",
            "\n",
            "    params = {\n",
            "        'q': location,\n",
            "        'appid': api_key,\n",
            "        'units': 'imperial'  # You can change 'imperial' to 'metric' for Celsius\n",
            "    }\n",
            "\n",
            "    response = requests.get(base_url, params=params)\n",
            "\n",
            "    if response.status_code == 200:\n",
            "        data = response.json()\n",
            "        weather_description = data['weather'][0]['description']\n",
            "        temperature = data['main']['temp']\n",
            "        humidity = data['main']['humidity']\n",
            "        wind_speed = data['wind']['speed']\n",
            "\n",
            "        print(f\"Current weather in {location}:\")\n",
            "        print(f\"Description: {weather_description}\")\n",
            "        print(f\"Temperature: {temperature} °F\")\n",
            "        print(f\"Humidity: {humidity}%\")\n",
            "        print(f\"Wind Speed: {wind_speed} mph\")\n",
            "    else:\n",
            "        print(\"Failed to retrieve weather data.\")\n",
            "\n",
            "# Replace 'Bay Area' with your desired location\n",
            "get_current_weather('Bay Area')\n",
            "```\n",
            "\n",
            "This code uses the `requests` library to make an API call to OpenWeatherMap. You'll need to sign up for an API key at [OpenWeatherMap](https://openweathermap.org/) and replace `\"YOUR_API_KEY\"` with your actual API key. The code sends a request to the OpenWeatherMap API with the location (in this case, 'Bay Area') and retrieves the current weather data.\n",
            "\n",
            "The code then extracts relevant information such as weather description, temperature, humidity, and wind speed from the API response and prints it to the console.\n",
            "\n",
            "Note: Make sure you have the `requests` library installed. You can install it using `pip install requests` if it's not already installed.\n",
            "\n",
            "When you run this code, it will display the current weather information for the Bay Area.\n"
          ]
        }
      ]
    },
    {
      "cell_type": "markdown",
      "source": [
        "# External knowledge in prompts, Grounding\n",
        "\n"
      ],
      "metadata": {
        "id": "EMW-amKXI-nk"
      }
    },
    {
      "cell_type": "markdown",
      "source": [
        "We've actually already seen external knowledge within our prompts. In the question and answer example, the `context` that we pasted in was a copy of phrasing on the Domino's website."
      ],
      "metadata": {
        "id": "UBxGhPzLebrA"
      }
    },
    {
      "cell_type": "code",
      "source": [
        "template = \"\"\"Read the context below and respond with an answer to the question. If the question cannot be answered based on the context alone or the context does not explicitly say the answer to the question, write \"Sorry I had trouble answering this question, based on the information I found.\"\n",
        "\n",
        "Context: {context}\n",
        "\n",
        "Question: {question}\n",
        "\n",
        "Answer:\n",
        "\"\"\"\n",
        "\n",
        "prompt = PromptTemplate(\n",
        "    input_variables=[\"context\", \"question\"],\n",
        "    template=template,\n",
        ")"
      ],
      "metadata": {
        "id": "vkmyGTHuJEc2"
      },
      "execution_count": 23,
      "outputs": []
    },
    {
      "cell_type": "code",
      "source": [
        "context = \"Domino's gift cards are great for any person and any occasion. There are a number of different options to choose from. Each comes with a personalized card carrier and is delivered via US Mail.\"\n",
        "\n",
        "question = \"How are gift cards delivered?\"\n",
        "\n",
        "myprompt = prompt.format(context=context, question=question)\n",
        "print(myprompt)"
      ],
      "metadata": {
        "id": "XRkwJGTOJIAC",
        "colab": {
          "base_uri": "https://localhost:8080/"
        },
        "outputId": "770ed0da-1d6c-4836-f6b6-6e673a9ff191"
      },
      "execution_count": 24,
      "outputs": [
        {
          "output_type": "stream",
          "name": "stdout",
          "text": [
            "Read the context below and respond with an answer to the question. If the question cannot be answered based on the context alone or the context does not explicitly say the answer to the question, write \"Sorry I had trouble answering this question, based on the information I found.\"\n",
            "\n",
            "Context: Domino's gift cards are great for any person and any occasion. There are a number of different options to choose from. Each comes with a personalized card carrier and is delivered via US Mail.\n",
            "\n",
            "Question: How are gift cards delivered?\n",
            "\n",
            "Answer:\n",
            "\n"
          ]
        }
      ]
    },
    {
      "cell_type": "code",
      "source": [
        "result = client.chat.completions.create(\n",
        "    model=\"Hermes-2-Pro-Llama-3-8B\",\n",
        "    messages=[{\"role\": \"user\", \"content\": myprompt}]\n",
        ")\n",
        "result['choices'][0]['message']['content']"
      ],
      "metadata": {
        "id": "sbyyGvyjJYCN",
        "colab": {
          "base_uri": "https://localhost:8080/",
          "height": 55
        },
        "outputId": "540de4d7-e62e-4627-be07-ca5eddbec4e1"
      },
      "execution_count": 25,
      "outputs": [
        {
          "output_type": "execute_result",
          "data": {
            "text/plain": [
              "'Gift cards are delivered via US Mail.'"
            ],
            "application/vnd.google.colaboratory.intrinsic+json": {
              "type": "string"
            }
          },
          "metadata": {},
          "execution_count": 25
        }
      ]
    },
    {
      "cell_type": "markdown",
      "source": [
        "# Retrieval augmentation"
      ],
      "metadata": {
        "id": "rEYisXxsynLc"
      }
    },
    {
      "cell_type": "markdown",
      "source": [
        "Retrieval-augmented generation (RAG) is an innovative approach that merges the capabilities of large-scale retrieval systems with sequence-to-sequence models to enhance their performance in generating detailed and contextually relevant responses. Instead of relying solely on the knowledge contained within the model's parameters, RAG allows the model to dynamically retrieve and integrate information from an external database or a set of documents during the generation process. By doing so, it provides a bridge between the vast knowledge stored in external sources and the powerful generation abilities of neural models, enabling more informed, diverse, and context-aware outputs in tasks like question answering, dialogue systems, and more."
      ],
      "metadata": {
        "id": "3ysqzdilA62F"
      }
    },
    {
      "cell_type": "code",
      "source": [
        "# Let's get the html off of a website.\n",
        "fp = urllib.request.urlopen(\"https://docs.kernel.org/process/submitting-patches.html\")\n",
        "mybytes = fp.read()\n",
        "html = mybytes.decode(\"utf8\")\n",
        "fp.close()\n",
        "\n",
        "# And convert it to text.\n",
        "h = html2text.HTML2Text()\n",
        "h.ignore_links = True\n",
        "text = h.handle(html)\n",
        "\n",
        "print(text)"
      ],
      "metadata": {
        "id": "c0AfYyA7vcrB",
        "colab": {
          "base_uri": "https://localhost:8080/"
        },
        "outputId": "57bf8dde-25da-44cd-8350-dc04b445ba12"
      },
      "execution_count": 26,
      "outputs": [
        {
          "output_type": "stream",
          "name": "stdout",
          "text": [
            "![Logo](../_static/logo.svg)\n",
            "\n",
            "# The Linux Kernel\n",
            "\n",
            "6.12.0\n",
            "\n",
            "### Quick search\n",
            "\n",
            "### Contents\n",
            "\n",
            "  * Development process\n",
            "  * Submitting patches\n",
            "    * Obtain a current source tree\n",
            "    * Describe your changes\n",
            "    * Separate your changes\n",
            "    * Style-check your changes\n",
            "    * Select the recipients for your patch\n",
            "    * No MIME, no links, no compression, no attachments. Just plain text\n",
            "    * Respond to review comments\n",
            "    * Use trimmed interleaved replies in email discussions\n",
            "    * Don’t get discouraged - or impatient\n",
            "    * Include PATCH in the subject\n",
            "    * Sign your work - the Developer’s Certificate of Origin\n",
            "      * Developer’s Certificate of Origin 1.1\n",
            "    * When to use Acked-by:, Cc:, and Co-developed-by:\n",
            "    * Using Reported-by:, Tested-by:, Reviewed-by:, Suggested-by: and Fixes:\n",
            "      * Reviewer’s statement of oversight\n",
            "    * The canonical patch format\n",
            "      * Backtraces in commit messages\n",
            "    * Explicit In-Reply-To headers\n",
            "    * Providing base tree information\n",
            "    * Tooling\n",
            "    * References\n",
            "  * Code of conduct\n",
            "  * Maintainer handbook\n",
            "  * All development-process docs\n",
            "\n",
            "  * Core API\n",
            "  * Driver APIs\n",
            "  * Subsystems\n",
            "  * Locking\n",
            "\n",
            "  * Licensing rules\n",
            "  * Writing documentation\n",
            "  * Development tools\n",
            "  * Testing guide\n",
            "  * Hacking guide\n",
            "  * Tracing\n",
            "  * Fault injection\n",
            "  * Livepatching\n",
            "  * Rust\n",
            "\n",
            "  * Administration\n",
            "  * Build system\n",
            "  * Reporting issues\n",
            "  * Userspace tools\n",
            "  * Userspace API\n",
            "\n",
            "  * Firmware\n",
            "  * Firmware and Devicetree\n",
            "\n",
            "  * CPU architectures\n",
            "\n",
            "  * Unsorted documentation\n",
            "\n",
            "  * Translations\n",
            "\n",
            "### This Page\n",
            "\n",
            "  * Show Source\n",
            "\n",
            "English\n",
            "\n",
            "  * Chinese (Simplified)\n",
            "  * Chinese (Traditional)\n",
            "  * Italian\n",
            "  * Spanish\n",
            "\n",
            "# Submitting patches: the essential guide to getting your code into the\n",
            "kernel¶\n",
            "\n",
            "For a person or company who wishes to submit a change to the Linux kernel, the\n",
            "process can sometimes be daunting if you’re not familiar with “the system.”\n",
            "This text is a collection of suggestions which can greatly increase the\n",
            "chances of your change being accepted.\n",
            "\n",
            "This document contains a large number of suggestions in a relatively terse\n",
            "format. For detailed information on how the kernel development process works,\n",
            "see A guide to the Kernel Development Process. Also, read Linux Kernel patch\n",
            "submission checklist for a list of items to check before submitting code. For\n",
            "device tree binding patches, read Submitting Devicetree (DT) binding patches.\n",
            "\n",
            "This documentation assumes that you’re using `git` to prepare your patches. If\n",
            "you’re unfamiliar with `git`, you would be well-advised to learn how to use\n",
            "it, it will make your life as a kernel developer and in general much easier.\n",
            "\n",
            "Some subsystems and maintainer trees have additional information about their\n",
            "workflow and expectations, see Documentation/process/maintainer-handbooks.rst.\n",
            "\n",
            "## Obtain a current source tree¶\n",
            "\n",
            "If you do not have a repository with the current kernel source handy, use\n",
            "`git` to obtain one. You’ll want to start with the mainline repository, which\n",
            "can be grabbed with:\n",
            "\n",
            "    \n",
            "    \n",
            "    git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git\n",
            "    \n",
            "\n",
            "Note, however, that you may not want to develop against the mainline tree\n",
            "directly. Most subsystem maintainers run their own trees and want to see\n",
            "patches prepared against those trees. See the **T:** entry for the subsystem\n",
            "in the MAINTAINERS file to find that tree, or simply ask the maintainer if the\n",
            "tree is not listed there.\n",
            "\n",
            "## Describe your changes¶\n",
            "\n",
            "Describe your problem. Whether your patch is a one-line bug fix or 5000 lines\n",
            "of a new feature, there must be an underlying problem that motivated you to do\n",
            "this work. Convince the reviewer that there is a problem worth fixing and that\n",
            "it makes sense for them to read past the first paragraph.\n",
            "\n",
            "Describe user-visible impact. Straight up crashes and lockups are pretty\n",
            "convincing, but not all bugs are that blatant. Even if the problem was spotted\n",
            "during code review, describe the impact you think it can have on users. Keep\n",
            "in mind that the majority of Linux installations run kernels from secondary\n",
            "stable trees or vendor/product-specific trees that cherry-pick only specific\n",
            "patches from upstream, so include anything that could help route your change\n",
            "downstream: provoking circumstances, excerpts from dmesg, crash descriptions,\n",
            "performance regressions, latency spikes, lockups, etc.\n",
            "\n",
            "Quantify optimizations and trade-offs. If you claim improvements in\n",
            "performance, memory consumption, stack footprint, or binary size, include\n",
            "numbers that back them up. But also describe non-obvious costs. Optimizations\n",
            "usually aren’t free but trade-offs between CPU, memory, and readability; or,\n",
            "when it comes to heuristics, between different workloads. Describe the\n",
            "expected downsides of your optimization so that the reviewer can weigh costs\n",
            "against benefits.\n",
            "\n",
            "Once the problem is established, describe what you are actually doing about it\n",
            "in technical detail. It’s important to describe the change in plain English\n",
            "for the reviewer to verify that the code is behaving as you intend it to.\n",
            "\n",
            "The maintainer will thank you if you write your patch description in a form\n",
            "which can be easily pulled into Linux’s source code management system, `git`,\n",
            "as a “commit log”. See The canonical patch format.\n",
            "\n",
            "Solve only one problem per patch. If your description starts to get long,\n",
            "that’s a sign that you probably need to split up your patch. See Separate your\n",
            "changes.\n",
            "\n",
            "When you submit or resubmit a patch or patch series, include the complete\n",
            "patch description and justification for it. Don’t just say that this is\n",
            "version N of the patch (series). Don’t expect the subsystem maintainer to\n",
            "refer back to earlier patch versions or referenced URLs to find the patch\n",
            "description and put that into the patch. I.e., the patch (series) and its\n",
            "description should be self-contained. This benefits both the maintainers and\n",
            "reviewers. Some reviewers probably didn’t even receive earlier versions of the\n",
            "patch.\n",
            "\n",
            "Describe your changes in imperative mood, e.g. “make xyzzy do frotz” instead\n",
            "of “[This patch] makes xyzzy do frotz” or “[I] changed xyzzy to do frotz”, as\n",
            "if you are giving orders to the codebase to change its behaviour.\n",
            "\n",
            "If you want to refer to a specific commit, don’t just refer to the SHA-1 ID of\n",
            "the commit. Please also include the oneline summary of the commit, to make it\n",
            "easier for reviewers to know what it is about. Example:\n",
            "\n",
            "    \n",
            "    \n",
            "    Commit e21d2170f36602ae2708 (\"video: remove unnecessary\n",
            "    platform_set_drvdata()\") removed the unnecessary\n",
            "    platform_set_drvdata(), but left the variable \"dev\" unused,\n",
            "    delete it.\n",
            "    \n",
            "\n",
            "You should also be sure to use at least the first twelve characters of the\n",
            "SHA-1 ID. The kernel repository holds a _lot_ of objects, making collisions\n",
            "with shorter IDs a real possibility. Bear in mind that, even if there is no\n",
            "collision with your six-character ID now, that condition may change five years\n",
            "from now.\n",
            "\n",
            "If related discussions or any other background information behind the change\n",
            "can be found on the web, add ‘Link:’ tags pointing to it. If the patch is a\n",
            "result of some earlier mailing list discussions or something documented on the\n",
            "web, point to it.\n",
            "\n",
            "When linking to mailing list archives, preferably use the lore.kernel.org\n",
            "message archiver service. To create the link URL, use the contents of the\n",
            "`Message-ID` header of the message without the surrounding angle brackets. For\n",
            "example:\n",
            "\n",
            "    \n",
            "    \n",
            "    Link: https://lore.kernel.org/30th.anniversary.repost@klaava.Helsinki.FI\n",
            "    \n",
            "\n",
            "Please check the link to make sure that it is actually working and points to\n",
            "the relevant message.\n",
            "\n",
            "However, try to make your explanation understandable without external\n",
            "resources. In addition to giving a URL to a mailing list archive or bug,\n",
            "summarize the relevant points of the discussion that led to the patch as\n",
            "submitted.\n",
            "\n",
            "In case your patch fixes a bug, use the ‘Closes:’ tag with a URL referencing\n",
            "the report in the mailing list archives or a public bug tracker. For example:\n",
            "\n",
            "    \n",
            "    \n",
            "    Closes: https://example.com/issues/1234\n",
            "    \n",
            "\n",
            "Some bug trackers have the ability to close issues automatically when a commit\n",
            "with such a tag is applied. Some bots monitoring mailing lists can also track\n",
            "such tags and take certain actions. Private bug trackers and invalid URLs are\n",
            "forbidden.\n",
            "\n",
            "If your patch fixes a bug in a specific commit, e.g. you found an issue using\n",
            "`git bisect`, please use the ‘Fixes:’ tag with the first 12 characters of the\n",
            "SHA-1 ID, and the one line summary. Do not split the tag across multiple\n",
            "lines, tags are exempt from the “wrap at 75 columns” rule in order to simplify\n",
            "parsing scripts. For example:\n",
            "\n",
            "    \n",
            "    \n",
            "    Fixes: 54a4f0239f2e (\"KVM: MMU: make kvm_mmu_zap_page() return the number of pages it actually freed\")\n",
            "    \n",
            "\n",
            "The following `git config` settings can be used to add a pretty format for\n",
            "outputting the above style in the `git log` or `git show` commands:\n",
            "\n",
            "    \n",
            "    \n",
            "    [core]\n",
            "            abbrev = 12\n",
            "    [pretty]\n",
            "            fixes = Fixes: %h (\\\"%s\\\")\n",
            "    \n",
            "\n",
            "An example call:\n",
            "\n",
            "    \n",
            "    \n",
            "    $ git log -1 --pretty=fixes 54a4f0239f2e\n",
            "    Fixes: 54a4f0239f2e (\"KVM: MMU: make kvm_mmu_zap_page() return the number of pages it actually freed\")\n",
            "    \n",
            "\n",
            "## Separate your changes¶\n",
            "\n",
            "Separate each **logical change** into a separate patch.\n",
            "\n",
            "For example, if your changes include both bug fixes and performance\n",
            "enhancements for a single driver, separate those changes into two or more\n",
            "patches. If your changes include an API update, and a new driver which uses\n",
            "that new API, separate those into two patches.\n",
            "\n",
            "On the other hand, if you make a single change to numerous files, group those\n",
            "changes into a single patch. Thus a single logical change is contained within\n",
            "a single patch.\n",
            "\n",
            "The point to remember is that each patch should make an easily understood\n",
            "change that can be verified by reviewers. Each patch should be justifiable on\n",
            "its own merits.\n",
            "\n",
            "If one patch depends on another patch in order for a change to be complete,\n",
            "that is OK. Simply note **“this patch depends on patch X”** in your patch\n",
            "description.\n",
            "\n",
            "When dividing your change into a series of patches, take special care to\n",
            "ensure that the kernel builds and runs properly after each patch in the\n",
            "series. Developers using `git bisect` to track down a problem can end up\n",
            "splitting your patch series at any point; they will not thank you if you\n",
            "introduce bugs in the middle.\n",
            "\n",
            "If you cannot condense your patch set into a smaller set of patches, then only\n",
            "post say 15 or so at a time and wait for review and integration.\n",
            "\n",
            "## Style-check your changes¶\n",
            "\n",
            "Check your patch for basic style violations, details of which can be found in\n",
            "Linux kernel coding style. Failure to do so simply wastes the reviewers time\n",
            "and will get your patch rejected, probably without even being read.\n",
            "\n",
            "One significant exception is when moving code from one file to another -- in\n",
            "this case you should not modify the moved code at all in the same patch which\n",
            "moves it. This clearly delineates the act of moving the code and your changes.\n",
            "This greatly aids review of the actual differences and allows tools to better\n",
            "track the history of the code itself.\n",
            "\n",
            "Check your patches with the patch style checker prior to submission\n",
            "(scripts/checkpatch.pl). Note, though, that the style checker should be viewed\n",
            "as a guide, not as a replacement for human judgment. If your code looks better\n",
            "with a violation then its probably best left alone.\n",
            "\n",
            "The checker reports at three levels:\n",
            "\n",
            "    \n",
            "\n",
            "  * ERROR: things that are very likely to be wrong\n",
            "\n",
            "  * WARNING: things requiring careful review\n",
            "\n",
            "  * CHECK: things requiring thought\n",
            "\n",
            "You should be able to justify all violations that remain in your patch.\n",
            "\n",
            "## Select the recipients for your patch¶\n",
            "\n",
            "You should always copy the appropriate subsystem maintainer(s) and list(s) on\n",
            "any patch to code that they maintain; look through the MAINTAINERS file and\n",
            "the source code revision history to see who those maintainers are. The script\n",
            "scripts/get_maintainer.pl can be very useful at this step (pass paths to your\n",
            "patches as arguments to scripts/get_maintainer.pl). If you cannot find a\n",
            "maintainer for the subsystem you are working on, Andrew Morton (akpm@linux-\n",
            "foundation.org) serves as a maintainer of last resort.\n",
            "\n",
            "linux-kernel@vger.kernel.org should be used by default for all patches, but\n",
            "the volume on that list has caused a number of developers to tune it out.\n",
            "Please do not spam unrelated lists and unrelated people, though.\n",
            "\n",
            "Many kernel-related lists are hosted at kernel.org; you can find a list of\n",
            "them at https://subspace.kernel.org. There are kernel-related lists hosted\n",
            "elsewhere as well, though.\n",
            "\n",
            "Linus Torvalds is the final arbiter of all changes accepted into the Linux\n",
            "kernel. His e-mail address is <torvalds@linux-foundation.org>. He gets a lot\n",
            "of e-mail, and, at this point, very few patches go through Linus directly, so\n",
            "typically you should do your best to -avoid- sending him e-mail.\n",
            "\n",
            "If you have a patch that fixes an exploitable security bug, send that patch to\n",
            "security@kernel.org. For severe bugs, a short embargo may be considered to\n",
            "allow distributors to get the patch out to users; in such cases, obviously,\n",
            "the patch should not be sent to any public lists. See also Security bugs.\n",
            "\n",
            "Patches that fix a severe bug in a released kernel should be directed toward\n",
            "the stable maintainers by putting a line like this:\n",
            "\n",
            "    \n",
            "    \n",
            "    Cc: stable@vger.kernel.org\n",
            "    \n",
            "\n",
            "into the sign-off area of your patch (note, NOT an email recipient). You\n",
            "should also read Everything you ever wanted to know about Linux -stable\n",
            "releases in addition to this document.\n",
            "\n",
            "If changes affect userland-kernel interfaces, please send the MAN-PAGES\n",
            "maintainer (as listed in the MAINTAINERS file) a man-pages patch, or at least\n",
            "a notification of the change, so that some information makes its way into the\n",
            "manual pages. User-space API changes should also be copied to linux-\n",
            "api@vger.kernel.org.\n",
            "\n",
            "## No MIME, no links, no compression, no attachments. Just plain text¶\n",
            "\n",
            "Linus and other kernel developers need to be able to read and comment on the\n",
            "changes you are submitting. It is important for a kernel developer to be able\n",
            "to “quote” your changes, using standard e-mail tools, so that they may comment\n",
            "on specific portions of your code.\n",
            "\n",
            "For this reason, all patches should be submitted by e-mail “inline”. The\n",
            "easiest way to do this is with `git send-email`, which is strongly\n",
            "recommended. An interactive tutorial for `git send-email` is available at\n",
            "https://git-send-email.io.\n",
            "\n",
            "If you choose not to use `git send-email`:\n",
            "\n",
            "Warning\n",
            "\n",
            "Be wary of your editor’s word-wrap corrupting your patch, if you choose to\n",
            "cut-n-paste your patch.\n",
            "\n",
            "Do not attach the patch as a MIME attachment, compressed or not. Many popular\n",
            "e-mail applications will not always transmit a MIME attachment as plain text,\n",
            "making it impossible to comment on your code. A MIME attachment also takes\n",
            "Linus a bit more time to process, decreasing the likelihood of your MIME-\n",
            "attached change being accepted.\n",
            "\n",
            "Exception: If your mailer is mangling patches then someone may ask you to re-\n",
            "send them using MIME.\n",
            "\n",
            "See Email clients info for Linux for hints about configuring your e-mail\n",
            "client so that it sends your patches untouched.\n",
            "\n",
            "## Respond to review comments¶\n",
            "\n",
            "Your patch will almost certainly get comments from reviewers on ways in which\n",
            "the patch can be improved, in the form of a reply to your email. You must\n",
            "respond to those comments; ignoring reviewers is a good way to get ignored in\n",
            "return. You can simply reply to their emails to answer their comments. Review\n",
            "comments or questions that do not lead to a code change should almost\n",
            "certainly bring about a comment or changelog entry so that the next reviewer\n",
            "better understands what is going on.\n",
            "\n",
            "Be sure to tell the reviewers what changes you are making and to thank them\n",
            "for their time. Code review is a tiring and time-consuming process, and\n",
            "reviewers sometimes get grumpy. Even in that case, though, respond politely\n",
            "and address the problems they have pointed out. When sending a next version,\n",
            "add a `patch changelog` to the cover letter or to individual patches\n",
            "explaining difference against previous submission (see The canonical patch\n",
            "format). Notify people that commented on your patch about new versions by\n",
            "adding them to the patches CC list.\n",
            "\n",
            "See Email clients info for Linux for recommendations on email clients and\n",
            "mailing list etiquette.\n",
            "\n",
            "## Use trimmed interleaved replies in email discussions¶\n",
            "\n",
            "Top-posting is strongly discouraged in Linux kernel development discussions.\n",
            "Interleaved (or “inline”) replies make conversations much easier to follow.\n",
            "For more details see:\n",
            "https://en.wikipedia.org/wiki/Posting_style#Interleaved_style\n",
            "\n",
            "As is frequently quoted on the mailing list:\n",
            "\n",
            "    \n",
            "    \n",
            "    A: http://en.wikipedia.org/wiki/Top_post\n",
            "    Q: Were do I find info about this thing called top-posting?\n",
            "    A: Because it messes up the order in which people normally read text.\n",
            "    Q: Why is top-posting such a bad thing?\n",
            "    A: Top-posting.\n",
            "    Q: What is the most annoying thing in e-mail?\n",
            "    \n",
            "\n",
            "Similarly, please trim all unneeded quotations that aren’t relevant to your\n",
            "reply. This makes responses easier to find, and saves time and space. For more\n",
            "details see: http://daringfireball.net/2007/07/on_top\n",
            "\n",
            "    \n",
            "    \n",
            "    A: No.\n",
            "    Q: Should I include quotations after my reply?\n",
            "    \n",
            "\n",
            "## Don’t get discouraged - or impatient¶\n",
            "\n",
            "After you have submitted your change, be patient and wait. Reviewers are busy\n",
            "people and may not get to your patch right away.\n",
            "\n",
            "Once upon a time, patches used to disappear into the void without comment, but\n",
            "the development process works more smoothly than that now. You should receive\n",
            "comments within a few weeks (typically 2-3); if that does not happen, make\n",
            "sure that you have sent your patches to the right place. Wait for a minimum of\n",
            "one week before resubmitting or pinging reviewers \\- possibly longer during\n",
            "busy times like merge windows.\n",
            "\n",
            "It’s also ok to resend the patch or the patch series after a couple of weeks\n",
            "with the word “RESEND” added to the subject line:\n",
            "\n",
            "    \n",
            "    \n",
            "    [PATCH Vx RESEND] sub/sys: Condensed patch summary\n",
            "    \n",
            "\n",
            "Don’t add “RESEND” when you are submitting a modified version of your patch or\n",
            "patch series - “RESEND” only applies to resubmission of a patch or patch\n",
            "series which have not been modified in any way from the previous submission.\n",
            "\n",
            "## Include PATCH in the subject¶\n",
            "\n",
            "Due to high e-mail traffic to Linus, and to linux-kernel, it is common\n",
            "convention to prefix your subject line with [PATCH]. This lets Linus and other\n",
            "kernel developers more easily distinguish patches from other e-mail\n",
            "discussions.\n",
            "\n",
            "`git send-email` will do this for you automatically.\n",
            "\n",
            "## Sign your work - the Developer’s Certificate of Origin¶\n",
            "\n",
            "To improve tracking of who did what, especially with patches that can\n",
            "percolate to their final resting place in the kernel through several layers of\n",
            "maintainers, we’ve introduced a “sign-off” procedure on patches that are being\n",
            "emailed around.\n",
            "\n",
            "The sign-off is a simple line at the end of the explanation for the patch,\n",
            "which certifies that you wrote it or otherwise have the right to pass it on as\n",
            "an open-source patch. The rules are pretty simple: if you can certify the\n",
            "below:\n",
            "\n",
            "### Developer’s Certificate of Origin 1.1¶\n",
            "\n",
            "By making a contribution to this project, I certify that:\n",
            "\n",
            ">   1. The contribution was created in whole or in part by me and I have the\n",
            "> right to submit it under the open source license indicated in the file; or\n",
            ">\n",
            ">   2. The contribution is based upon previous work that, to the best of my\n",
            "> knowledge, is covered under an appropriate open source license and I have\n",
            "> the right under that license to submit that work with modifications, whether\n",
            "> created in whole or in part by me, under the same open source license\n",
            "> (unless I am permitted to submit under a different license), as indicated in\n",
            "> the file; or\n",
            ">\n",
            ">   3. The contribution was provided directly to me by some other person who\n",
            "> certified (a), (b) or (c) and I have not modified it.\n",
            ">\n",
            ">   4. I understand and agree that this project and the contribution are\n",
            "> public and that a record of the contribution (including all personal\n",
            "> information I submit with it, including my sign-off) is maintained\n",
            "> indefinitely and may be redistributed consistent with this project or the\n",
            "> open source license(s) involved.\n",
            ">\n",
            ">\n",
            "\n",
            "then you just add a line saying:\n",
            "\n",
            "    \n",
            "    \n",
            "    Signed-off-by: Random J Developer <random@developer.example.org>\n",
            "    \n",
            "\n",
            "using a known identity (sorry, no anonymous contributions.) This will be done\n",
            "for you automatically if you use `git commit -s`. Reverts should also include\n",
            "“Signed-off-by”. `git revert -s` does that for you.\n",
            "\n",
            "Some people also put extra tags at the end. They’ll just be ignored for now,\n",
            "but you can do this to mark internal company procedures or just point out some\n",
            "special detail about the sign-off.\n",
            "\n",
            "Any further SoBs (Signed-off-by:’s) following the author’s SoB are from people\n",
            "handling and transporting the patch, but were not involved in its development.\n",
            "SoB chains should reflect the **real** route a patch took as it was propagated\n",
            "to the maintainers and ultimately to Linus, with the first SoB entry\n",
            "signalling primary authorship of a single author.\n",
            "\n",
            "## When to use Acked-by:, Cc:, and Co-developed-by:¶\n",
            "\n",
            "The Signed-off-by: tag indicates that the signer was involved in the\n",
            "development of the patch, or that he/she was in the patch’s delivery path.\n",
            "\n",
            "If a person was not directly involved in the preparation or handling of a\n",
            "patch but wishes to signify and record their approval of it then they can ask\n",
            "to have an Acked-by: line added to the patch’s changelog.\n",
            "\n",
            "Acked-by: is often used by the maintainer of the affected code when that\n",
            "maintainer neither contributed to nor forwarded the patch.\n",
            "\n",
            "Acked-by: is not as formal as Signed-off-by:. It is a record that the acker\n",
            "has at least reviewed the patch and has indicated acceptance. Hence patch\n",
            "mergers will sometimes manually convert an acker’s “yep, looks good to me”\n",
            "into an Acked-by: (but note that it is usually better to ask for an explicit\n",
            "ack).\n",
            "\n",
            "Acked-by: does not necessarily indicate acknowledgement of the entire patch.\n",
            "For example, if a patch affects multiple subsystems and has an Acked-by: from\n",
            "one subsystem maintainer then this usually indicates acknowledgement of just\n",
            "the part which affects that maintainer’s code. Judgement should be used here.\n",
            "When in doubt people should refer to the original discussion in the mailing\n",
            "list archives.\n",
            "\n",
            "If a person has had the opportunity to comment on a patch, but has not\n",
            "provided such comments, you may optionally add a `Cc:` tag to the patch. This\n",
            "is the only tag which might be added without an explicit action by the person\n",
            "it names - but it should indicate that this person was copied on the patch.\n",
            "This tag documents that potentially interested parties have been included in\n",
            "the discussion.\n",
            "\n",
            "Co-developed-by: states that the patch was co-created by multiple developers;\n",
            "it is used to give attribution to co-authors (in addition to the author\n",
            "attributed by the From: tag) when several people work on a single patch. Since\n",
            "Co-developed-by: denotes authorship, every Co-developed-by: must be\n",
            "immediately followed by a Signed-off-by: of the associated co-author. Standard\n",
            "sign-off procedure applies, i.e. the ordering of Signed-off-by: tags should\n",
            "reflect the chronological history of the patch insofar as possible, regardless\n",
            "of whether the author is attributed via From: or Co-developed-by:. Notably,\n",
            "the last Signed-off-by: must always be that of the developer submitting the\n",
            "patch.\n",
            "\n",
            "Note, the From: tag is optional when the From: author is also the person (and\n",
            "email) listed in the From: line of the email header.\n",
            "\n",
            "Example of a patch submitted by the From: author:\n",
            "\n",
            "    \n",
            "    \n",
            "    <changelog>\n",
            "    \n",
            "    Co-developed-by: First Co-Author <first@coauthor.example.org>\n",
            "    Signed-off-by: First Co-Author <first@coauthor.example.org>\n",
            "    Co-developed-by: Second Co-Author <second@coauthor.example.org>\n",
            "    Signed-off-by: Second Co-Author <second@coauthor.example.org>\n",
            "    Signed-off-by: From Author <from@author.example.org>\n",
            "    \n",
            "\n",
            "Example of a patch submitted by a Co-developed-by: author:\n",
            "\n",
            "    \n",
            "    \n",
            "    From: From Author <from@author.example.org>\n",
            "    \n",
            "    <changelog>\n",
            "    \n",
            "    Co-developed-by: Random Co-Author <random@coauthor.example.org>\n",
            "    Signed-off-by: Random Co-Author <random@coauthor.example.org>\n",
            "    Signed-off-by: From Author <from@author.example.org>\n",
            "    Co-developed-by: Submitting Co-Author <sub@coauthor.example.org>\n",
            "    Signed-off-by: Submitting Co-Author <sub@coauthor.example.org>\n",
            "    \n",
            "\n",
            "## Using Reported-by:, Tested-by:, Reviewed-by:, Suggested-by: and Fixes:¶\n",
            "\n",
            "The Reported-by tag gives credit to people who find bugs and report them and\n",
            "it hopefully inspires them to help us again in the future. The tag is intended\n",
            "for bugs; please do not use it to credit feature requests. The tag should be\n",
            "followed by a Closes: tag pointing to the report, unless the report is not\n",
            "available on the web. The Link: tag can be used instead of Closes: if the\n",
            "patch fixes a part of the issue(s) being reported. Please note that if the bug\n",
            "was reported in private, then ask for permission first before using the\n",
            "Reported-by tag.\n",
            "\n",
            "A Tested-by: tag indicates that the patch has been successfully tested (in\n",
            "some environment) by the person named. This tag informs maintainers that some\n",
            "testing has been performed, provides a means to locate testers for future\n",
            "patches, and ensures credit for the testers.\n",
            "\n",
            "Reviewed-by:, instead, indicates that the patch has been reviewed and found\n",
            "acceptable according to the Reviewer’s Statement:\n",
            "\n",
            "### Reviewer’s statement of oversight¶\n",
            "\n",
            "By offering my Reviewed-by: tag, I state that:\n",
            "\n",
            ">   1. I have carried out a technical review of this patch to evaluate its\n",
            "> appropriateness and readiness for inclusion into the mainline kernel.\n",
            ">\n",
            ">   2. Any problems, concerns, or questions relating to the patch have been\n",
            "> communicated back to the submitter. I am satisfied with the submitter’s\n",
            "> response to my comments.\n",
            ">\n",
            ">   3. While there may be things that could be improved with this submission,\n",
            "> I believe that it is, at this time, (1) a worthwhile modification to the\n",
            "> kernel, and (2) free of known issues which would argue against its\n",
            "> inclusion.\n",
            ">\n",
            ">   4. While I have reviewed the patch and believe it to be sound, I do not\n",
            "> (unless explicitly stated elsewhere) make any warranties or guarantees that\n",
            "> it will achieve its stated purpose or function properly in any given\n",
            "> situation.\n",
            ">\n",
            ">\n",
            "\n",
            "A Reviewed-by tag is a statement of opinion that the patch is an appropriate\n",
            "modification of the kernel without any remaining serious technical issues. Any\n",
            "interested reviewer (who has done the work) can offer a Reviewed-by tag for a\n",
            "patch. This tag serves to give credit to reviewers and to inform maintainers\n",
            "of the degree of review which has been done on the patch. Reviewed-by: tags,\n",
            "when supplied by reviewers known to understand the subject area and to perform\n",
            "thorough reviews, will normally increase the likelihood of your patch getting\n",
            "into the kernel.\n",
            "\n",
            "Both Tested-by and Reviewed-by tags, once received on mailing list from tester\n",
            "or reviewer, should be added by author to the applicable patches when sending\n",
            "next versions. However if the patch has changed substantially in following\n",
            "version, these tags might not be applicable anymore and thus should be\n",
            "removed. Usually removal of someone’s Tested-by or Reviewed-by tags should be\n",
            "mentioned in the patch changelog (after the ‘---’ separator).\n",
            "\n",
            "A Suggested-by: tag indicates that the patch idea is suggested by the person\n",
            "named and ensures credit to the person for the idea. Please note that this tag\n",
            "should not be added without the reporter’s permission, especially if the idea\n",
            "was not posted in a public forum. That said, if we diligently credit our idea\n",
            "reporters, they will, hopefully, be inspired to help us again in the future.\n",
            "\n",
            "A Fixes: tag indicates that the patch fixes an issue in a previous commit. It\n",
            "is used to make it easy to determine where a bug originated, which can help\n",
            "review a bug fix. This tag also assists the stable kernel team in determining\n",
            "which stable kernel versions should receive your fix. This is the preferred\n",
            "method for indicating a bug fixed by the patch. See Describe your changes for\n",
            "more details.\n",
            "\n",
            "Note: Attaching a Fixes: tag does not subvert the stable kernel rules process\n",
            "nor the requirement to Cc: stable@vger.kernel.org on all stable patch\n",
            "candidates. For more information, please read Everything you ever wanted to\n",
            "know about Linux -stable releases.\n",
            "\n",
            "## The canonical patch format¶\n",
            "\n",
            "This section describes how the patch itself should be formatted. Note that, if\n",
            "you have your patches stored in a `git` repository, proper patch formatting\n",
            "can be had with `git format-patch`. The tools cannot create the necessary\n",
            "text, though, so read the instructions below anyway.\n",
            "\n",
            "The canonical patch subject line is:\n",
            "\n",
            "    \n",
            "    \n",
            "    Subject: [PATCH 001/123] subsystem: summary phrase\n",
            "    \n",
            "\n",
            "The canonical patch message body contains the following:\n",
            "\n",
            ">   * A `from` line specifying the patch author, followed by an empty line\n",
            "> (only needed if the person sending the patch is not the author).\n",
            ">\n",
            ">   * The body of the explanation, line wrapped at 75 columns, which will be\n",
            "> copied to the permanent changelog to describe this patch.\n",
            ">\n",
            ">   * An empty line.\n",
            ">\n",
            ">   * The `Signed-off-by:` lines, described above, which will also go in the\n",
            "> changelog.\n",
            ">\n",
            ">   * A marker line containing simply `---`.\n",
            ">\n",
            ">   * Any additional comments not suitable for the changelog.\n",
            ">\n",
            ">   * The actual patch (`diff` output).\n",
            ">\n",
            ">\n",
            "\n",
            "The Subject line format makes it very easy to sort the emails alphabetically\n",
            "by subject line - pretty much any email reader will support that - since\n",
            "because the sequence number is zero-padded, the numerical and alphabetic sort\n",
            "is the same.\n",
            "\n",
            "The `subsystem` in the email’s Subject should identify which area or subsystem\n",
            "of the kernel is being patched.\n",
            "\n",
            "The `summary phrase` in the email’s Subject should concisely describe the\n",
            "patch which that email contains. The `summary phrase` should not be a\n",
            "filename. Do not use the same `summary phrase` for every patch in a whole\n",
            "patch series (where a `patch series` is an ordered sequence of multiple,\n",
            "related patches).\n",
            "\n",
            "Bear in mind that the `summary phrase` of your email becomes a globally-unique\n",
            "identifier for that patch. It propagates all the way into the `git` changelog.\n",
            "The `summary phrase` may later be used in developer discussions which refer to\n",
            "the patch. People will want to google for the `summary phrase` to read\n",
            "discussion regarding that patch. It will also be the only thing that people\n",
            "may quickly see when, two or three months later, they are going through\n",
            "perhaps thousands of patches using tools such as `gitk` or `git log\n",
            "--oneline`.\n",
            "\n",
            "For these reasons, the `summary` must be no more than 70-75 characters, and it\n",
            "must describe both what the patch changes, as well as why the patch might be\n",
            "necessary. It is challenging to be both succinct and descriptive, but that is\n",
            "what a well-written summary should do.\n",
            "\n",
            "The `summary phrase` may be prefixed by tags enclosed in square brackets:\n",
            "“Subject: [PATCH <tag>...] <summary phrase>”. The tags are not considered part\n",
            "of the summary phrase, but describe how the patch should be treated. Common\n",
            "tags might include a version descriptor if the multiple versions of the patch\n",
            "have been sent out in response to comments (i.e., “v1, v2, v3”), or “RFC” to\n",
            "indicate a request for comments.\n",
            "\n",
            "If there are four patches in a patch series the individual patches may be\n",
            "numbered like this: 1/4, 2/4, 3/4, 4/4. This assures that developers\n",
            "understand the order in which the patches should be applied and that they have\n",
            "reviewed or applied all of the patches in the patch series.\n",
            "\n",
            "Here are some good example Subjects:\n",
            "\n",
            "    \n",
            "    \n",
            "    Subject: [PATCH 2/5] ext2: improve scalability of bitmap searching\n",
            "    Subject: [PATCH v2 01/27] x86: fix eflags tracking\n",
            "    Subject: [PATCH v2] sub/sys: Condensed patch summary\n",
            "    Subject: [PATCH v2 M/N] sub/sys: Condensed patch summary\n",
            "    \n",
            "\n",
            "The `from` line must be the very first line in the message body, and has the\n",
            "form:\n",
            "\n",
            "> From: Patch Author <author@example.com>\n",
            "\n",
            "The `from` line specifies who will be credited as the author of the patch in\n",
            "the permanent changelog. If the `from` line is missing, then the `From:` line\n",
            "from the email header will be used to determine the patch author in the\n",
            "changelog.\n",
            "\n",
            "The explanation body will be committed to the permanent source changelog, so\n",
            "should make sense to a competent reader who has long since forgotten the\n",
            "immediate details of the discussion that might have led to this patch.\n",
            "Including symptoms of the failure which the patch addresses (kernel log\n",
            "messages, oops messages, etc.) are especially useful for people who might be\n",
            "searching the commit logs looking for the applicable patch. The text should be\n",
            "written in such detail so that when read weeks, months or even years later, it\n",
            "can give the reader the needed details to grasp the reasoning for **why** the\n",
            "patch was created.\n",
            "\n",
            "If a patch fixes a compile failure, it may not be necessary to include _all_\n",
            "of the compile failures; just enough that it is likely that someone searching\n",
            "for the patch can find it. As in the `summary phrase`, it is important to be\n",
            "both succinct as well as descriptive.\n",
            "\n",
            "The `---` marker line serves the essential purpose of marking for patch\n",
            "handling tools where the changelog message ends.\n",
            "\n",
            "One good use for the additional comments after the `---` marker is for a\n",
            "`diffstat`, to show what files have changed, and the number of inserted and\n",
            "deleted lines per file. A `diffstat` is especially useful on bigger patches.\n",
            "If you are going to include a `diffstat` after the `---` marker, please use\n",
            "`diffstat` options `-p 1 -w 70` so that filenames are listed from the top of\n",
            "the kernel source tree and don’t use too much horizontal space (easily fit in\n",
            "80 columns, maybe with some indentation). (`git` generates appropriate\n",
            "diffstats by default.)\n",
            "\n",
            "Other comments relevant only to the moment or the maintainer, not suitable for\n",
            "the permanent changelog, should also go here. A good example of such comments\n",
            "might be `patch changelogs` which describe what has changed between the v1 and\n",
            "v2 version of the patch.\n",
            "\n",
            "Please put this information **after** the `---` line which separates the\n",
            "changelog from the rest of the patch. The version information is not part of\n",
            "the changelog which gets committed to the git tree. It is additional\n",
            "information for the reviewers. If it’s placed above the commit tags, it needs\n",
            "manual interaction to remove it. If it is below the separator line, it gets\n",
            "automatically stripped off when applying the patch:\n",
            "\n",
            "    \n",
            "    \n",
            "    <commit message>\n",
            "    ...\n",
            "    Signed-off-by: Author <author@mail>\n",
            "    ---\n",
            "    V2 -> V3: Removed redundant helper function\n",
            "    V1 -> V2: Cleaned up coding style and addressed review comments\n",
            "    \n",
            "    path/to/file | 5+++--\n",
            "    ...\n",
            "    \n",
            "\n",
            "See more details on the proper patch format in the following references.\n",
            "\n",
            "### Backtraces in commit messages¶\n",
            "\n",
            "Backtraces help document the call chain leading to a problem. However, not all\n",
            "backtraces are helpful. For example, early boot call chains are unique and\n",
            "obvious. Copying the full dmesg output verbatim, however, adds distracting\n",
            "information like timestamps, module lists, register and stack dumps.\n",
            "\n",
            "Therefore, the most useful backtraces should distill the relevant information\n",
            "from the dump, which makes it easier to focus on the real issue. Here is an\n",
            "example of a well-trimmed backtrace:\n",
            "\n",
            "    \n",
            "    \n",
            "    unchecked MSR access error: WRMSR to 0xd51 (tried to write 0x0000000000000064)\n",
            "    at rIP: 0xffffffffae059994 (native_write_msr+0x4/0x20)\n",
            "    Call Trace:\n",
            "    mba_wrmsr\n",
            "    update_domains\n",
            "    rdtgroup_mkdir\n",
            "    \n",
            "\n",
            "## Explicit In-Reply-To headers¶\n",
            "\n",
            "It can be helpful to manually add In-Reply-To: headers to a patch (e.g., when\n",
            "using `git send-email`) to associate the patch with previous relevant\n",
            "discussion, e.g. to link a bug fix to the email with the bug report. However,\n",
            "for a multi-patch series, it is generally best to avoid using In-Reply-To: to\n",
            "link to older versions of the series. This way multiple versions of the patch\n",
            "don’t become an unmanageable forest of references in email clients. If a link\n",
            "is helpful, you can use the https://lore.kernel.org/ redirector (e.g., in the\n",
            "cover email text) to link to an earlier version of the patch series.\n",
            "\n",
            "## Providing base tree information¶\n",
            "\n",
            "When other developers receive your patches and start the review process, it is\n",
            "absolutely necessary for them to know what is the base commit/branch your work\n",
            "applies on, considering the sheer amount of maintainer trees present nowadays.\n",
            "Note again the **T:** entry in the MAINTAINERS file explained above.\n",
            "\n",
            "This is even more important for automated CI processes that attempt to run a\n",
            "series of tests in order to establish the quality of your submission before\n",
            "the maintainer starts the review.\n",
            "\n",
            "If you are using `git format-patch` to generate your patches, you can\n",
            "automatically include the base tree information in your submission by using\n",
            "the `--base` flag. The easiest and most convenient way to use this option is\n",
            "with topical branches:\n",
            "\n",
            "    \n",
            "    \n",
            "    $ git checkout -t -b my-topical-branch master\n",
            "    Branch 'my-topical-branch' set up to track local branch 'master'.\n",
            "    Switched to a new branch 'my-topical-branch'\n",
            "    \n",
            "    [perform your edits and commits]\n",
            "    \n",
            "    $ git format-patch --base=auto --cover-letter -o outgoing/ master\n",
            "    outgoing/0000-cover-letter.patch\n",
            "    outgoing/0001-First-Commit.patch\n",
            "    outgoing/...\n",
            "    \n",
            "\n",
            "When you open `outgoing/0000-cover-letter.patch` for editing, you will notice\n",
            "that it will have the `base-commit:` trailer at the very bottom, which\n",
            "provides the reviewer and the CI tools enough information to properly perform\n",
            "`git am` without worrying about conflicts:\n",
            "\n",
            "    \n",
            "    \n",
            "    $ git checkout -b patch-review [base-commit-id]\n",
            "    Switched to a new branch 'patch-review'\n",
            "    $ git am patches.mbox\n",
            "    Applying: First Commit\n",
            "    Applying: ...\n",
            "    \n",
            "\n",
            "Please see `man git-format-patch` for more information about this option.\n",
            "\n",
            "Note\n",
            "\n",
            "The `--base` feature was introduced in git version 2.9.0.\n",
            "\n",
            "If you are not using git to format your patches, you can still include the\n",
            "same `base-commit` trailer to indicate the commit hash of the tree on which\n",
            "your work is based. You should add it either in the cover letter or in the\n",
            "first patch of the series and it should be placed either below the `---` line\n",
            "or at the very bottom of all other content, right before your email signature.\n",
            "\n",
            "Make sure that base commit is in an official maintainer/mainline tree and not\n",
            "in some internal, accessible only to you tree - otherwise it would be\n",
            "worthless.\n",
            "\n",
            "## Tooling¶\n",
            "\n",
            "Many of the technical aspects of this process can be automated using b4,\n",
            "documented at <https://b4.docs.kernel.org/en/latest/>. This can help with\n",
            "things like tracking dependencies, running checkpatch and with formatting and\n",
            "sending mails.\n",
            "\n",
            "## References¶\n",
            "\n",
            "Andrew Morton, “The perfect patch” (tpp).\n",
            "\n",
            "    \n",
            "\n",
            "<https://www.ozlabs.org/~akpm/stuff/tpp.txt>\n",
            "\n",
            "Jeff Garzik, “Linux kernel patch submission format”.\n",
            "\n",
            "    \n",
            "\n",
            "<https://web.archive.org/web/20180829112450/http://linux.yyz.us/patch-\n",
            "format.html>\n",
            "\n",
            "Greg Kroah-Hartman, “How to piss off a kernel subsystem maintainer”.\n",
            "\n",
            "    \n",
            "\n",
            "<http://www.kroah.com/log/linux/maintainer.html>\n",
            "\n",
            "<http://www.kroah.com/log/linux/maintainer-02.html>\n",
            "\n",
            "<http://www.kroah.com/log/linux/maintainer-03.html>\n",
            "\n",
            "<http://www.kroah.com/log/linux/maintainer-04.html>\n",
            "\n",
            "<http://www.kroah.com/log/linux/maintainer-05.html>\n",
            "\n",
            "<http://www.kroah.com/log/linux/maintainer-06.html>\n",
            "\n",
            "Kernel Linux kernel coding style\n",
            "\n",
            "Linus Torvalds’s mail on the canonical patch format:\n",
            "\n",
            "    \n",
            "\n",
            "<https://lore.kernel.org/r/Pine.LNX.4.58.0504071023190.28951@ppc970.osdl.org>\n",
            "\n",
            "Andi Kleen, “On submitting kernel patches”\n",
            "\n",
            "    \n",
            "\n",
            "Some strategies to get difficult or controversial changes in.\n",
            "\n",
            "http://halobates.de/on-submitting-patches.pdf\n",
            "\n",
            "(C)The kernel development community. | Powered by Sphinx 5.3.0 & Alabaster 0.7.16 | Page source\n",
            "\n",
            "\n"
          ]
        }
      ]
    },
    {
      "cell_type": "code",
      "source": [
        "# Clean things up just a bit.\n",
        "text = text.split(\"### This Page\")[1]\n",
        "text = text.split(\"## References\")[0]\n",
        "print(text)"
      ],
      "metadata": {
        "id": "AnH3LL-owZOW",
        "colab": {
          "base_uri": "https://localhost:8080/"
        },
        "outputId": "c7483083-1ab6-425a-ee1a-28b90bb6611c"
      },
      "execution_count": 27,
      "outputs": [
        {
          "output_type": "stream",
          "name": "stdout",
          "text": [
            "\n",
            "\n",
            "  * Show Source\n",
            "\n",
            "English\n",
            "\n",
            "  * Chinese (Simplified)\n",
            "  * Chinese (Traditional)\n",
            "  * Italian\n",
            "  * Spanish\n",
            "\n",
            "# Submitting patches: the essential guide to getting your code into the\n",
            "kernel¶\n",
            "\n",
            "For a person or company who wishes to submit a change to the Linux kernel, the\n",
            "process can sometimes be daunting if you’re not familiar with “the system.”\n",
            "This text is a collection of suggestions which can greatly increase the\n",
            "chances of your change being accepted.\n",
            "\n",
            "This document contains a large number of suggestions in a relatively terse\n",
            "format. For detailed information on how the kernel development process works,\n",
            "see A guide to the Kernel Development Process. Also, read Linux Kernel patch\n",
            "submission checklist for a list of items to check before submitting code. For\n",
            "device tree binding patches, read Submitting Devicetree (DT) binding patches.\n",
            "\n",
            "This documentation assumes that you’re using `git` to prepare your patches. If\n",
            "you’re unfamiliar with `git`, you would be well-advised to learn how to use\n",
            "it, it will make your life as a kernel developer and in general much easier.\n",
            "\n",
            "Some subsystems and maintainer trees have additional information about their\n",
            "workflow and expectations, see Documentation/process/maintainer-handbooks.rst.\n",
            "\n",
            "## Obtain a current source tree¶\n",
            "\n",
            "If you do not have a repository with the current kernel source handy, use\n",
            "`git` to obtain one. You’ll want to start with the mainline repository, which\n",
            "can be grabbed with:\n",
            "\n",
            "    \n",
            "    \n",
            "    git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git\n",
            "    \n",
            "\n",
            "Note, however, that you may not want to develop against the mainline tree\n",
            "directly. Most subsystem maintainers run their own trees and want to see\n",
            "patches prepared against those trees. See the **T:** entry for the subsystem\n",
            "in the MAINTAINERS file to find that tree, or simply ask the maintainer if the\n",
            "tree is not listed there.\n",
            "\n",
            "## Describe your changes¶\n",
            "\n",
            "Describe your problem. Whether your patch is a one-line bug fix or 5000 lines\n",
            "of a new feature, there must be an underlying problem that motivated you to do\n",
            "this work. Convince the reviewer that there is a problem worth fixing and that\n",
            "it makes sense for them to read past the first paragraph.\n",
            "\n",
            "Describe user-visible impact. Straight up crashes and lockups are pretty\n",
            "convincing, but not all bugs are that blatant. Even if the problem was spotted\n",
            "during code review, describe the impact you think it can have on users. Keep\n",
            "in mind that the majority of Linux installations run kernels from secondary\n",
            "stable trees or vendor/product-specific trees that cherry-pick only specific\n",
            "patches from upstream, so include anything that could help route your change\n",
            "downstream: provoking circumstances, excerpts from dmesg, crash descriptions,\n",
            "performance regressions, latency spikes, lockups, etc.\n",
            "\n",
            "Quantify optimizations and trade-offs. If you claim improvements in\n",
            "performance, memory consumption, stack footprint, or binary size, include\n",
            "numbers that back them up. But also describe non-obvious costs. Optimizations\n",
            "usually aren’t free but trade-offs between CPU, memory, and readability; or,\n",
            "when it comes to heuristics, between different workloads. Describe the\n",
            "expected downsides of your optimization so that the reviewer can weigh costs\n",
            "against benefits.\n",
            "\n",
            "Once the problem is established, describe what you are actually doing about it\n",
            "in technical detail. It’s important to describe the change in plain English\n",
            "for the reviewer to verify that the code is behaving as you intend it to.\n",
            "\n",
            "The maintainer will thank you if you write your patch description in a form\n",
            "which can be easily pulled into Linux’s source code management system, `git`,\n",
            "as a “commit log”. See The canonical patch format.\n",
            "\n",
            "Solve only one problem per patch. If your description starts to get long,\n",
            "that’s a sign that you probably need to split up your patch. See Separate your\n",
            "changes.\n",
            "\n",
            "When you submit or resubmit a patch or patch series, include the complete\n",
            "patch description and justification for it. Don’t just say that this is\n",
            "version N of the patch (series). Don’t expect the subsystem maintainer to\n",
            "refer back to earlier patch versions or referenced URLs to find the patch\n",
            "description and put that into the patch. I.e., the patch (series) and its\n",
            "description should be self-contained. This benefits both the maintainers and\n",
            "reviewers. Some reviewers probably didn’t even receive earlier versions of the\n",
            "patch.\n",
            "\n",
            "Describe your changes in imperative mood, e.g. “make xyzzy do frotz” instead\n",
            "of “[This patch] makes xyzzy do frotz” or “[I] changed xyzzy to do frotz”, as\n",
            "if you are giving orders to the codebase to change its behaviour.\n",
            "\n",
            "If you want to refer to a specific commit, don’t just refer to the SHA-1 ID of\n",
            "the commit. Please also include the oneline summary of the commit, to make it\n",
            "easier for reviewers to know what it is about. Example:\n",
            "\n",
            "    \n",
            "    \n",
            "    Commit e21d2170f36602ae2708 (\"video: remove unnecessary\n",
            "    platform_set_drvdata()\") removed the unnecessary\n",
            "    platform_set_drvdata(), but left the variable \"dev\" unused,\n",
            "    delete it.\n",
            "    \n",
            "\n",
            "You should also be sure to use at least the first twelve characters of the\n",
            "SHA-1 ID. The kernel repository holds a _lot_ of objects, making collisions\n",
            "with shorter IDs a real possibility. Bear in mind that, even if there is no\n",
            "collision with your six-character ID now, that condition may change five years\n",
            "from now.\n",
            "\n",
            "If related discussions or any other background information behind the change\n",
            "can be found on the web, add ‘Link:’ tags pointing to it. If the patch is a\n",
            "result of some earlier mailing list discussions or something documented on the\n",
            "web, point to it.\n",
            "\n",
            "When linking to mailing list archives, preferably use the lore.kernel.org\n",
            "message archiver service. To create the link URL, use the contents of the\n",
            "`Message-ID` header of the message without the surrounding angle brackets. For\n",
            "example:\n",
            "\n",
            "    \n",
            "    \n",
            "    Link: https://lore.kernel.org/30th.anniversary.repost@klaava.Helsinki.FI\n",
            "    \n",
            "\n",
            "Please check the link to make sure that it is actually working and points to\n",
            "the relevant message.\n",
            "\n",
            "However, try to make your explanation understandable without external\n",
            "resources. In addition to giving a URL to a mailing list archive or bug,\n",
            "summarize the relevant points of the discussion that led to the patch as\n",
            "submitted.\n",
            "\n",
            "In case your patch fixes a bug, use the ‘Closes:’ tag with a URL referencing\n",
            "the report in the mailing list archives or a public bug tracker. For example:\n",
            "\n",
            "    \n",
            "    \n",
            "    Closes: https://example.com/issues/1234\n",
            "    \n",
            "\n",
            "Some bug trackers have the ability to close issues automatically when a commit\n",
            "with such a tag is applied. Some bots monitoring mailing lists can also track\n",
            "such tags and take certain actions. Private bug trackers and invalid URLs are\n",
            "forbidden.\n",
            "\n",
            "If your patch fixes a bug in a specific commit, e.g. you found an issue using\n",
            "`git bisect`, please use the ‘Fixes:’ tag with the first 12 characters of the\n",
            "SHA-1 ID, and the one line summary. Do not split the tag across multiple\n",
            "lines, tags are exempt from the “wrap at 75 columns” rule in order to simplify\n",
            "parsing scripts. For example:\n",
            "\n",
            "    \n",
            "    \n",
            "    Fixes: 54a4f0239f2e (\"KVM: MMU: make kvm_mmu_zap_page() return the number of pages it actually freed\")\n",
            "    \n",
            "\n",
            "The following `git config` settings can be used to add a pretty format for\n",
            "outputting the above style in the `git log` or `git show` commands:\n",
            "\n",
            "    \n",
            "    \n",
            "    [core]\n",
            "            abbrev = 12\n",
            "    [pretty]\n",
            "            fixes = Fixes: %h (\\\"%s\\\")\n",
            "    \n",
            "\n",
            "An example call:\n",
            "\n",
            "    \n",
            "    \n",
            "    $ git log -1 --pretty=fixes 54a4f0239f2e\n",
            "    Fixes: 54a4f0239f2e (\"KVM: MMU: make kvm_mmu_zap_page() return the number of pages it actually freed\")\n",
            "    \n",
            "\n",
            "## Separate your changes¶\n",
            "\n",
            "Separate each **logical change** into a separate patch.\n",
            "\n",
            "For example, if your changes include both bug fixes and performance\n",
            "enhancements for a single driver, separate those changes into two or more\n",
            "patches. If your changes include an API update, and a new driver which uses\n",
            "that new API, separate those into two patches.\n",
            "\n",
            "On the other hand, if you make a single change to numerous files, group those\n",
            "changes into a single patch. Thus a single logical change is contained within\n",
            "a single patch.\n",
            "\n",
            "The point to remember is that each patch should make an easily understood\n",
            "change that can be verified by reviewers. Each patch should be justifiable on\n",
            "its own merits.\n",
            "\n",
            "If one patch depends on another patch in order for a change to be complete,\n",
            "that is OK. Simply note **“this patch depends on patch X”** in your patch\n",
            "description.\n",
            "\n",
            "When dividing your change into a series of patches, take special care to\n",
            "ensure that the kernel builds and runs properly after each patch in the\n",
            "series. Developers using `git bisect` to track down a problem can end up\n",
            "splitting your patch series at any point; they will not thank you if you\n",
            "introduce bugs in the middle.\n",
            "\n",
            "If you cannot condense your patch set into a smaller set of patches, then only\n",
            "post say 15 or so at a time and wait for review and integration.\n",
            "\n",
            "## Style-check your changes¶\n",
            "\n",
            "Check your patch for basic style violations, details of which can be found in\n",
            "Linux kernel coding style. Failure to do so simply wastes the reviewers time\n",
            "and will get your patch rejected, probably without even being read.\n",
            "\n",
            "One significant exception is when moving code from one file to another -- in\n",
            "this case you should not modify the moved code at all in the same patch which\n",
            "moves it. This clearly delineates the act of moving the code and your changes.\n",
            "This greatly aids review of the actual differences and allows tools to better\n",
            "track the history of the code itself.\n",
            "\n",
            "Check your patches with the patch style checker prior to submission\n",
            "(scripts/checkpatch.pl). Note, though, that the style checker should be viewed\n",
            "as a guide, not as a replacement for human judgment. If your code looks better\n",
            "with a violation then its probably best left alone.\n",
            "\n",
            "The checker reports at three levels:\n",
            "\n",
            "    \n",
            "\n",
            "  * ERROR: things that are very likely to be wrong\n",
            "\n",
            "  * WARNING: things requiring careful review\n",
            "\n",
            "  * CHECK: things requiring thought\n",
            "\n",
            "You should be able to justify all violations that remain in your patch.\n",
            "\n",
            "## Select the recipients for your patch¶\n",
            "\n",
            "You should always copy the appropriate subsystem maintainer(s) and list(s) on\n",
            "any patch to code that they maintain; look through the MAINTAINERS file and\n",
            "the source code revision history to see who those maintainers are. The script\n",
            "scripts/get_maintainer.pl can be very useful at this step (pass paths to your\n",
            "patches as arguments to scripts/get_maintainer.pl). If you cannot find a\n",
            "maintainer for the subsystem you are working on, Andrew Morton (akpm@linux-\n",
            "foundation.org) serves as a maintainer of last resort.\n",
            "\n",
            "linux-kernel@vger.kernel.org should be used by default for all patches, but\n",
            "the volume on that list has caused a number of developers to tune it out.\n",
            "Please do not spam unrelated lists and unrelated people, though.\n",
            "\n",
            "Many kernel-related lists are hosted at kernel.org; you can find a list of\n",
            "them at https://subspace.kernel.org. There are kernel-related lists hosted\n",
            "elsewhere as well, though.\n",
            "\n",
            "Linus Torvalds is the final arbiter of all changes accepted into the Linux\n",
            "kernel. His e-mail address is <torvalds@linux-foundation.org>. He gets a lot\n",
            "of e-mail, and, at this point, very few patches go through Linus directly, so\n",
            "typically you should do your best to -avoid- sending him e-mail.\n",
            "\n",
            "If you have a patch that fixes an exploitable security bug, send that patch to\n",
            "security@kernel.org. For severe bugs, a short embargo may be considered to\n",
            "allow distributors to get the patch out to users; in such cases, obviously,\n",
            "the patch should not be sent to any public lists. See also Security bugs.\n",
            "\n",
            "Patches that fix a severe bug in a released kernel should be directed toward\n",
            "the stable maintainers by putting a line like this:\n",
            "\n",
            "    \n",
            "    \n",
            "    Cc: stable@vger.kernel.org\n",
            "    \n",
            "\n",
            "into the sign-off area of your patch (note, NOT an email recipient). You\n",
            "should also read Everything you ever wanted to know about Linux -stable\n",
            "releases in addition to this document.\n",
            "\n",
            "If changes affect userland-kernel interfaces, please send the MAN-PAGES\n",
            "maintainer (as listed in the MAINTAINERS file) a man-pages patch, or at least\n",
            "a notification of the change, so that some information makes its way into the\n",
            "manual pages. User-space API changes should also be copied to linux-\n",
            "api@vger.kernel.org.\n",
            "\n",
            "## No MIME, no links, no compression, no attachments. Just plain text¶\n",
            "\n",
            "Linus and other kernel developers need to be able to read and comment on the\n",
            "changes you are submitting. It is important for a kernel developer to be able\n",
            "to “quote” your changes, using standard e-mail tools, so that they may comment\n",
            "on specific portions of your code.\n",
            "\n",
            "For this reason, all patches should be submitted by e-mail “inline”. The\n",
            "easiest way to do this is with `git send-email`, which is strongly\n",
            "recommended. An interactive tutorial for `git send-email` is available at\n",
            "https://git-send-email.io.\n",
            "\n",
            "If you choose not to use `git send-email`:\n",
            "\n",
            "Warning\n",
            "\n",
            "Be wary of your editor’s word-wrap corrupting your patch, if you choose to\n",
            "cut-n-paste your patch.\n",
            "\n",
            "Do not attach the patch as a MIME attachment, compressed or not. Many popular\n",
            "e-mail applications will not always transmit a MIME attachment as plain text,\n",
            "making it impossible to comment on your code. A MIME attachment also takes\n",
            "Linus a bit more time to process, decreasing the likelihood of your MIME-\n",
            "attached change being accepted.\n",
            "\n",
            "Exception: If your mailer is mangling patches then someone may ask you to re-\n",
            "send them using MIME.\n",
            "\n",
            "See Email clients info for Linux for hints about configuring your e-mail\n",
            "client so that it sends your patches untouched.\n",
            "\n",
            "## Respond to review comments¶\n",
            "\n",
            "Your patch will almost certainly get comments from reviewers on ways in which\n",
            "the patch can be improved, in the form of a reply to your email. You must\n",
            "respond to those comments; ignoring reviewers is a good way to get ignored in\n",
            "return. You can simply reply to their emails to answer their comments. Review\n",
            "comments or questions that do not lead to a code change should almost\n",
            "certainly bring about a comment or changelog entry so that the next reviewer\n",
            "better understands what is going on.\n",
            "\n",
            "Be sure to tell the reviewers what changes you are making and to thank them\n",
            "for their time. Code review is a tiring and time-consuming process, and\n",
            "reviewers sometimes get grumpy. Even in that case, though, respond politely\n",
            "and address the problems they have pointed out. When sending a next version,\n",
            "add a `patch changelog` to the cover letter or to individual patches\n",
            "explaining difference against previous submission (see The canonical patch\n",
            "format). Notify people that commented on your patch about new versions by\n",
            "adding them to the patches CC list.\n",
            "\n",
            "See Email clients info for Linux for recommendations on email clients and\n",
            "mailing list etiquette.\n",
            "\n",
            "## Use trimmed interleaved replies in email discussions¶\n",
            "\n",
            "Top-posting is strongly discouraged in Linux kernel development discussions.\n",
            "Interleaved (or “inline”) replies make conversations much easier to follow.\n",
            "For more details see:\n",
            "https://en.wikipedia.org/wiki/Posting_style#Interleaved_style\n",
            "\n",
            "As is frequently quoted on the mailing list:\n",
            "\n",
            "    \n",
            "    \n",
            "    A: http://en.wikipedia.org/wiki/Top_post\n",
            "    Q: Were do I find info about this thing called top-posting?\n",
            "    A: Because it messes up the order in which people normally read text.\n",
            "    Q: Why is top-posting such a bad thing?\n",
            "    A: Top-posting.\n",
            "    Q: What is the most annoying thing in e-mail?\n",
            "    \n",
            "\n",
            "Similarly, please trim all unneeded quotations that aren’t relevant to your\n",
            "reply. This makes responses easier to find, and saves time and space. For more\n",
            "details see: http://daringfireball.net/2007/07/on_top\n",
            "\n",
            "    \n",
            "    \n",
            "    A: No.\n",
            "    Q: Should I include quotations after my reply?\n",
            "    \n",
            "\n",
            "## Don’t get discouraged - or impatient¶\n",
            "\n",
            "After you have submitted your change, be patient and wait. Reviewers are busy\n",
            "people and may not get to your patch right away.\n",
            "\n",
            "Once upon a time, patches used to disappear into the void without comment, but\n",
            "the development process works more smoothly than that now. You should receive\n",
            "comments within a few weeks (typically 2-3); if that does not happen, make\n",
            "sure that you have sent your patches to the right place. Wait for a minimum of\n",
            "one week before resubmitting or pinging reviewers \\- possibly longer during\n",
            "busy times like merge windows.\n",
            "\n",
            "It’s also ok to resend the patch or the patch series after a couple of weeks\n",
            "with the word “RESEND” added to the subject line:\n",
            "\n",
            "    \n",
            "    \n",
            "    [PATCH Vx RESEND] sub/sys: Condensed patch summary\n",
            "    \n",
            "\n",
            "Don’t add “RESEND” when you are submitting a modified version of your patch or\n",
            "patch series - “RESEND” only applies to resubmission of a patch or patch\n",
            "series which have not been modified in any way from the previous submission.\n",
            "\n",
            "## Include PATCH in the subject¶\n",
            "\n",
            "Due to high e-mail traffic to Linus, and to linux-kernel, it is common\n",
            "convention to prefix your subject line with [PATCH]. This lets Linus and other\n",
            "kernel developers more easily distinguish patches from other e-mail\n",
            "discussions.\n",
            "\n",
            "`git send-email` will do this for you automatically.\n",
            "\n",
            "## Sign your work - the Developer’s Certificate of Origin¶\n",
            "\n",
            "To improve tracking of who did what, especially with patches that can\n",
            "percolate to their final resting place in the kernel through several layers of\n",
            "maintainers, we’ve introduced a “sign-off” procedure on patches that are being\n",
            "emailed around.\n",
            "\n",
            "The sign-off is a simple line at the end of the explanation for the patch,\n",
            "which certifies that you wrote it or otherwise have the right to pass it on as\n",
            "an open-source patch. The rules are pretty simple: if you can certify the\n",
            "below:\n",
            "\n",
            "### Developer’s Certificate of Origin 1.1¶\n",
            "\n",
            "By making a contribution to this project, I certify that:\n",
            "\n",
            ">   1. The contribution was created in whole or in part by me and I have the\n",
            "> right to submit it under the open source license indicated in the file; or\n",
            ">\n",
            ">   2. The contribution is based upon previous work that, to the best of my\n",
            "> knowledge, is covered under an appropriate open source license and I have\n",
            "> the right under that license to submit that work with modifications, whether\n",
            "> created in whole or in part by me, under the same open source license\n",
            "> (unless I am permitted to submit under a different license), as indicated in\n",
            "> the file; or\n",
            ">\n",
            ">   3. The contribution was provided directly to me by some other person who\n",
            "> certified (a), (b) or (c) and I have not modified it.\n",
            ">\n",
            ">   4. I understand and agree that this project and the contribution are\n",
            "> public and that a record of the contribution (including all personal\n",
            "> information I submit with it, including my sign-off) is maintained\n",
            "> indefinitely and may be redistributed consistent with this project or the\n",
            "> open source license(s) involved.\n",
            ">\n",
            ">\n",
            "\n",
            "then you just add a line saying:\n",
            "\n",
            "    \n",
            "    \n",
            "    Signed-off-by: Random J Developer <random@developer.example.org>\n",
            "    \n",
            "\n",
            "using a known identity (sorry, no anonymous contributions.) This will be done\n",
            "for you automatically if you use `git commit -s`. Reverts should also include\n",
            "“Signed-off-by”. `git revert -s` does that for you.\n",
            "\n",
            "Some people also put extra tags at the end. They’ll just be ignored for now,\n",
            "but you can do this to mark internal company procedures or just point out some\n",
            "special detail about the sign-off.\n",
            "\n",
            "Any further SoBs (Signed-off-by:’s) following the author’s SoB are from people\n",
            "handling and transporting the patch, but were not involved in its development.\n",
            "SoB chains should reflect the **real** route a patch took as it was propagated\n",
            "to the maintainers and ultimately to Linus, with the first SoB entry\n",
            "signalling primary authorship of a single author.\n",
            "\n",
            "## When to use Acked-by:, Cc:, and Co-developed-by:¶\n",
            "\n",
            "The Signed-off-by: tag indicates that the signer was involved in the\n",
            "development of the patch, or that he/she was in the patch’s delivery path.\n",
            "\n",
            "If a person was not directly involved in the preparation or handling of a\n",
            "patch but wishes to signify and record their approval of it then they can ask\n",
            "to have an Acked-by: line added to the patch’s changelog.\n",
            "\n",
            "Acked-by: is often used by the maintainer of the affected code when that\n",
            "maintainer neither contributed to nor forwarded the patch.\n",
            "\n",
            "Acked-by: is not as formal as Signed-off-by:. It is a record that the acker\n",
            "has at least reviewed the patch and has indicated acceptance. Hence patch\n",
            "mergers will sometimes manually convert an acker’s “yep, looks good to me”\n",
            "into an Acked-by: (but note that it is usually better to ask for an explicit\n",
            "ack).\n",
            "\n",
            "Acked-by: does not necessarily indicate acknowledgement of the entire patch.\n",
            "For example, if a patch affects multiple subsystems and has an Acked-by: from\n",
            "one subsystem maintainer then this usually indicates acknowledgement of just\n",
            "the part which affects that maintainer’s code. Judgement should be used here.\n",
            "When in doubt people should refer to the original discussion in the mailing\n",
            "list archives.\n",
            "\n",
            "If a person has had the opportunity to comment on a patch, but has not\n",
            "provided such comments, you may optionally add a `Cc:` tag to the patch. This\n",
            "is the only tag which might be added without an explicit action by the person\n",
            "it names - but it should indicate that this person was copied on the patch.\n",
            "This tag documents that potentially interested parties have been included in\n",
            "the discussion.\n",
            "\n",
            "Co-developed-by: states that the patch was co-created by multiple developers;\n",
            "it is used to give attribution to co-authors (in addition to the author\n",
            "attributed by the From: tag) when several people work on a single patch. Since\n",
            "Co-developed-by: denotes authorship, every Co-developed-by: must be\n",
            "immediately followed by a Signed-off-by: of the associated co-author. Standard\n",
            "sign-off procedure applies, i.e. the ordering of Signed-off-by: tags should\n",
            "reflect the chronological history of the patch insofar as possible, regardless\n",
            "of whether the author is attributed via From: or Co-developed-by:. Notably,\n",
            "the last Signed-off-by: must always be that of the developer submitting the\n",
            "patch.\n",
            "\n",
            "Note, the From: tag is optional when the From: author is also the person (and\n",
            "email) listed in the From: line of the email header.\n",
            "\n",
            "Example of a patch submitted by the From: author:\n",
            "\n",
            "    \n",
            "    \n",
            "    <changelog>\n",
            "    \n",
            "    Co-developed-by: First Co-Author <first@coauthor.example.org>\n",
            "    Signed-off-by: First Co-Author <first@coauthor.example.org>\n",
            "    Co-developed-by: Second Co-Author <second@coauthor.example.org>\n",
            "    Signed-off-by: Second Co-Author <second@coauthor.example.org>\n",
            "    Signed-off-by: From Author <from@author.example.org>\n",
            "    \n",
            "\n",
            "Example of a patch submitted by a Co-developed-by: author:\n",
            "\n",
            "    \n",
            "    \n",
            "    From: From Author <from@author.example.org>\n",
            "    \n",
            "    <changelog>\n",
            "    \n",
            "    Co-developed-by: Random Co-Author <random@coauthor.example.org>\n",
            "    Signed-off-by: Random Co-Author <random@coauthor.example.org>\n",
            "    Signed-off-by: From Author <from@author.example.org>\n",
            "    Co-developed-by: Submitting Co-Author <sub@coauthor.example.org>\n",
            "    Signed-off-by: Submitting Co-Author <sub@coauthor.example.org>\n",
            "    \n",
            "\n",
            "## Using Reported-by:, Tested-by:, Reviewed-by:, Suggested-by: and Fixes:¶\n",
            "\n",
            "The Reported-by tag gives credit to people who find bugs and report them and\n",
            "it hopefully inspires them to help us again in the future. The tag is intended\n",
            "for bugs; please do not use it to credit feature requests. The tag should be\n",
            "followed by a Closes: tag pointing to the report, unless the report is not\n",
            "available on the web. The Link: tag can be used instead of Closes: if the\n",
            "patch fixes a part of the issue(s) being reported. Please note that if the bug\n",
            "was reported in private, then ask for permission first before using the\n",
            "Reported-by tag.\n",
            "\n",
            "A Tested-by: tag indicates that the patch has been successfully tested (in\n",
            "some environment) by the person named. This tag informs maintainers that some\n",
            "testing has been performed, provides a means to locate testers for future\n",
            "patches, and ensures credit for the testers.\n",
            "\n",
            "Reviewed-by:, instead, indicates that the patch has been reviewed and found\n",
            "acceptable according to the Reviewer’s Statement:\n",
            "\n",
            "### Reviewer’s statement of oversight¶\n",
            "\n",
            "By offering my Reviewed-by: tag, I state that:\n",
            "\n",
            ">   1. I have carried out a technical review of this patch to evaluate its\n",
            "> appropriateness and readiness for inclusion into the mainline kernel.\n",
            ">\n",
            ">   2. Any problems, concerns, or questions relating to the patch have been\n",
            "> communicated back to the submitter. I am satisfied with the submitter’s\n",
            "> response to my comments.\n",
            ">\n",
            ">   3. While there may be things that could be improved with this submission,\n",
            "> I believe that it is, at this time, (1) a worthwhile modification to the\n",
            "> kernel, and (2) free of known issues which would argue against its\n",
            "> inclusion.\n",
            ">\n",
            ">   4. While I have reviewed the patch and believe it to be sound, I do not\n",
            "> (unless explicitly stated elsewhere) make any warranties or guarantees that\n",
            "> it will achieve its stated purpose or function properly in any given\n",
            "> situation.\n",
            ">\n",
            ">\n",
            "\n",
            "A Reviewed-by tag is a statement of opinion that the patch is an appropriate\n",
            "modification of the kernel without any remaining serious technical issues. Any\n",
            "interested reviewer (who has done the work) can offer a Reviewed-by tag for a\n",
            "patch. This tag serves to give credit to reviewers and to inform maintainers\n",
            "of the degree of review which has been done on the patch. Reviewed-by: tags,\n",
            "when supplied by reviewers known to understand the subject area and to perform\n",
            "thorough reviews, will normally increase the likelihood of your patch getting\n",
            "into the kernel.\n",
            "\n",
            "Both Tested-by and Reviewed-by tags, once received on mailing list from tester\n",
            "or reviewer, should be added by author to the applicable patches when sending\n",
            "next versions. However if the patch has changed substantially in following\n",
            "version, these tags might not be applicable anymore and thus should be\n",
            "removed. Usually removal of someone’s Tested-by or Reviewed-by tags should be\n",
            "mentioned in the patch changelog (after the ‘---’ separator).\n",
            "\n",
            "A Suggested-by: tag indicates that the patch idea is suggested by the person\n",
            "named and ensures credit to the person for the idea. Please note that this tag\n",
            "should not be added without the reporter’s permission, especially if the idea\n",
            "was not posted in a public forum. That said, if we diligently credit our idea\n",
            "reporters, they will, hopefully, be inspired to help us again in the future.\n",
            "\n",
            "A Fixes: tag indicates that the patch fixes an issue in a previous commit. It\n",
            "is used to make it easy to determine where a bug originated, which can help\n",
            "review a bug fix. This tag also assists the stable kernel team in determining\n",
            "which stable kernel versions should receive your fix. This is the preferred\n",
            "method for indicating a bug fixed by the patch. See Describe your changes for\n",
            "more details.\n",
            "\n",
            "Note: Attaching a Fixes: tag does not subvert the stable kernel rules process\n",
            "nor the requirement to Cc: stable@vger.kernel.org on all stable patch\n",
            "candidates. For more information, please read Everything you ever wanted to\n",
            "know about Linux -stable releases.\n",
            "\n",
            "## The canonical patch format¶\n",
            "\n",
            "This section describes how the patch itself should be formatted. Note that, if\n",
            "you have your patches stored in a `git` repository, proper patch formatting\n",
            "can be had with `git format-patch`. The tools cannot create the necessary\n",
            "text, though, so read the instructions below anyway.\n",
            "\n",
            "The canonical patch subject line is:\n",
            "\n",
            "    \n",
            "    \n",
            "    Subject: [PATCH 001/123] subsystem: summary phrase\n",
            "    \n",
            "\n",
            "The canonical patch message body contains the following:\n",
            "\n",
            ">   * A `from` line specifying the patch author, followed by an empty line\n",
            "> (only needed if the person sending the patch is not the author).\n",
            ">\n",
            ">   * The body of the explanation, line wrapped at 75 columns, which will be\n",
            "> copied to the permanent changelog to describe this patch.\n",
            ">\n",
            ">   * An empty line.\n",
            ">\n",
            ">   * The `Signed-off-by:` lines, described above, which will also go in the\n",
            "> changelog.\n",
            ">\n",
            ">   * A marker line containing simply `---`.\n",
            ">\n",
            ">   * Any additional comments not suitable for the changelog.\n",
            ">\n",
            ">   * The actual patch (`diff` output).\n",
            ">\n",
            ">\n",
            "\n",
            "The Subject line format makes it very easy to sort the emails alphabetically\n",
            "by subject line - pretty much any email reader will support that - since\n",
            "because the sequence number is zero-padded, the numerical and alphabetic sort\n",
            "is the same.\n",
            "\n",
            "The `subsystem` in the email’s Subject should identify which area or subsystem\n",
            "of the kernel is being patched.\n",
            "\n",
            "The `summary phrase` in the email’s Subject should concisely describe the\n",
            "patch which that email contains. The `summary phrase` should not be a\n",
            "filename. Do not use the same `summary phrase` for every patch in a whole\n",
            "patch series (where a `patch series` is an ordered sequence of multiple,\n",
            "related patches).\n",
            "\n",
            "Bear in mind that the `summary phrase` of your email becomes a globally-unique\n",
            "identifier for that patch. It propagates all the way into the `git` changelog.\n",
            "The `summary phrase` may later be used in developer discussions which refer to\n",
            "the patch. People will want to google for the `summary phrase` to read\n",
            "discussion regarding that patch. It will also be the only thing that people\n",
            "may quickly see when, two or three months later, they are going through\n",
            "perhaps thousands of patches using tools such as `gitk` or `git log\n",
            "--oneline`.\n",
            "\n",
            "For these reasons, the `summary` must be no more than 70-75 characters, and it\n",
            "must describe both what the patch changes, as well as why the patch might be\n",
            "necessary. It is challenging to be both succinct and descriptive, but that is\n",
            "what a well-written summary should do.\n",
            "\n",
            "The `summary phrase` may be prefixed by tags enclosed in square brackets:\n",
            "“Subject: [PATCH <tag>...] <summary phrase>”. The tags are not considered part\n",
            "of the summary phrase, but describe how the patch should be treated. Common\n",
            "tags might include a version descriptor if the multiple versions of the patch\n",
            "have been sent out in response to comments (i.e., “v1, v2, v3”), or “RFC” to\n",
            "indicate a request for comments.\n",
            "\n",
            "If there are four patches in a patch series the individual patches may be\n",
            "numbered like this: 1/4, 2/4, 3/4, 4/4. This assures that developers\n",
            "understand the order in which the patches should be applied and that they have\n",
            "reviewed or applied all of the patches in the patch series.\n",
            "\n",
            "Here are some good example Subjects:\n",
            "\n",
            "    \n",
            "    \n",
            "    Subject: [PATCH 2/5] ext2: improve scalability of bitmap searching\n",
            "    Subject: [PATCH v2 01/27] x86: fix eflags tracking\n",
            "    Subject: [PATCH v2] sub/sys: Condensed patch summary\n",
            "    Subject: [PATCH v2 M/N] sub/sys: Condensed patch summary\n",
            "    \n",
            "\n",
            "The `from` line must be the very first line in the message body, and has the\n",
            "form:\n",
            "\n",
            "> From: Patch Author <author@example.com>\n",
            "\n",
            "The `from` line specifies who will be credited as the author of the patch in\n",
            "the permanent changelog. If the `from` line is missing, then the `From:` line\n",
            "from the email header will be used to determine the patch author in the\n",
            "changelog.\n",
            "\n",
            "The explanation body will be committed to the permanent source changelog, so\n",
            "should make sense to a competent reader who has long since forgotten the\n",
            "immediate details of the discussion that might have led to this patch.\n",
            "Including symptoms of the failure which the patch addresses (kernel log\n",
            "messages, oops messages, etc.) are especially useful for people who might be\n",
            "searching the commit logs looking for the applicable patch. The text should be\n",
            "written in such detail so that when read weeks, months or even years later, it\n",
            "can give the reader the needed details to grasp the reasoning for **why** the\n",
            "patch was created.\n",
            "\n",
            "If a patch fixes a compile failure, it may not be necessary to include _all_\n",
            "of the compile failures; just enough that it is likely that someone searching\n",
            "for the patch can find it. As in the `summary phrase`, it is important to be\n",
            "both succinct as well as descriptive.\n",
            "\n",
            "The `---` marker line serves the essential purpose of marking for patch\n",
            "handling tools where the changelog message ends.\n",
            "\n",
            "One good use for the additional comments after the `---` marker is for a\n",
            "`diffstat`, to show what files have changed, and the number of inserted and\n",
            "deleted lines per file. A `diffstat` is especially useful on bigger patches.\n",
            "If you are going to include a `diffstat` after the `---` marker, please use\n",
            "`diffstat` options `-p 1 -w 70` so that filenames are listed from the top of\n",
            "the kernel source tree and don’t use too much horizontal space (easily fit in\n",
            "80 columns, maybe with some indentation). (`git` generates appropriate\n",
            "diffstats by default.)\n",
            "\n",
            "Other comments relevant only to the moment or the maintainer, not suitable for\n",
            "the permanent changelog, should also go here. A good example of such comments\n",
            "might be `patch changelogs` which describe what has changed between the v1 and\n",
            "v2 version of the patch.\n",
            "\n",
            "Please put this information **after** the `---` line which separates the\n",
            "changelog from the rest of the patch. The version information is not part of\n",
            "the changelog which gets committed to the git tree. It is additional\n",
            "information for the reviewers. If it’s placed above the commit tags, it needs\n",
            "manual interaction to remove it. If it is below the separator line, it gets\n",
            "automatically stripped off when applying the patch:\n",
            "\n",
            "    \n",
            "    \n",
            "    <commit message>\n",
            "    ...\n",
            "    Signed-off-by: Author <author@mail>\n",
            "    ---\n",
            "    V2 -> V3: Removed redundant helper function\n",
            "    V1 -> V2: Cleaned up coding style and addressed review comments\n",
            "    \n",
            "    path/to/file | 5+++--\n",
            "    ...\n",
            "    \n",
            "\n",
            "See more details on the proper patch format in the following references.\n",
            "\n",
            "### Backtraces in commit messages¶\n",
            "\n",
            "Backtraces help document the call chain leading to a problem. However, not all\n",
            "backtraces are helpful. For example, early boot call chains are unique and\n",
            "obvious. Copying the full dmesg output verbatim, however, adds distracting\n",
            "information like timestamps, module lists, register and stack dumps.\n",
            "\n",
            "Therefore, the most useful backtraces should distill the relevant information\n",
            "from the dump, which makes it easier to focus on the real issue. Here is an\n",
            "example of a well-trimmed backtrace:\n",
            "\n",
            "    \n",
            "    \n",
            "    unchecked MSR access error: WRMSR to 0xd51 (tried to write 0x0000000000000064)\n",
            "    at rIP: 0xffffffffae059994 (native_write_msr+0x4/0x20)\n",
            "    Call Trace:\n",
            "    mba_wrmsr\n",
            "    update_domains\n",
            "    rdtgroup_mkdir\n",
            "    \n",
            "\n",
            "## Explicit In-Reply-To headers¶\n",
            "\n",
            "It can be helpful to manually add In-Reply-To: headers to a patch (e.g., when\n",
            "using `git send-email`) to associate the patch with previous relevant\n",
            "discussion, e.g. to link a bug fix to the email with the bug report. However,\n",
            "for a multi-patch series, it is generally best to avoid using In-Reply-To: to\n",
            "link to older versions of the series. This way multiple versions of the patch\n",
            "don’t become an unmanageable forest of references in email clients. If a link\n",
            "is helpful, you can use the https://lore.kernel.org/ redirector (e.g., in the\n",
            "cover email text) to link to an earlier version of the patch series.\n",
            "\n",
            "## Providing base tree information¶\n",
            "\n",
            "When other developers receive your patches and start the review process, it is\n",
            "absolutely necessary for them to know what is the base commit/branch your work\n",
            "applies on, considering the sheer amount of maintainer trees present nowadays.\n",
            "Note again the **T:** entry in the MAINTAINERS file explained above.\n",
            "\n",
            "This is even more important for automated CI processes that attempt to run a\n",
            "series of tests in order to establish the quality of your submission before\n",
            "the maintainer starts the review.\n",
            "\n",
            "If you are using `git format-patch` to generate your patches, you can\n",
            "automatically include the base tree information in your submission by using\n",
            "the `--base` flag. The easiest and most convenient way to use this option is\n",
            "with topical branches:\n",
            "\n",
            "    \n",
            "    \n",
            "    $ git checkout -t -b my-topical-branch master\n",
            "    Branch 'my-topical-branch' set up to track local branch 'master'.\n",
            "    Switched to a new branch 'my-topical-branch'\n",
            "    \n",
            "    [perform your edits and commits]\n",
            "    \n",
            "    $ git format-patch --base=auto --cover-letter -o outgoing/ master\n",
            "    outgoing/0000-cover-letter.patch\n",
            "    outgoing/0001-First-Commit.patch\n",
            "    outgoing/...\n",
            "    \n",
            "\n",
            "When you open `outgoing/0000-cover-letter.patch` for editing, you will notice\n",
            "that it will have the `base-commit:` trailer at the very bottom, which\n",
            "provides the reviewer and the CI tools enough information to properly perform\n",
            "`git am` without worrying about conflicts:\n",
            "\n",
            "    \n",
            "    \n",
            "    $ git checkout -b patch-review [base-commit-id]\n",
            "    Switched to a new branch 'patch-review'\n",
            "    $ git am patches.mbox\n",
            "    Applying: First Commit\n",
            "    Applying: ...\n",
            "    \n",
            "\n",
            "Please see `man git-format-patch` for more information about this option.\n",
            "\n",
            "Note\n",
            "\n",
            "The `--base` feature was introduced in git version 2.9.0.\n",
            "\n",
            "If you are not using git to format your patches, you can still include the\n",
            "same `base-commit` trailer to indicate the commit hash of the tree on which\n",
            "your work is based. You should add it either in the cover letter or in the\n",
            "first patch of the series and it should be placed either below the `---` line\n",
            "or at the very bottom of all other content, right before your email signature.\n",
            "\n",
            "Make sure that base commit is in an official maintainer/mainline tree and not\n",
            "in some internal, accessible only to you tree - otherwise it would be\n",
            "worthless.\n",
            "\n",
            "## Tooling¶\n",
            "\n",
            "Many of the technical aspects of this process can be automated using b4,\n",
            "documented at <https://b4.docs.kernel.org/en/latest/>. This can help with\n",
            "things like tracking dependencies, running checkpatch and with formatting and\n",
            "sending mails.\n",
            "\n",
            "\n"
          ]
        }
      ]
    },
    {
      "cell_type": "code",
      "source": [
        "# Chunk the text into smaller pieces for injection into LLM prompts.\n",
        "text_splitter = CharacterTextSplitter(chunk_size=700, chunk_overlap=50)\n",
        "docs = text_splitter.split_text(text)\n",
        "len(docs)"
      ],
      "metadata": {
        "id": "KjNBPI_Fwv5K",
        "colab": {
          "base_uri": "https://localhost:8080/"
        },
        "outputId": "b07df2e8-02ab-4acc-c6ad-813d96ca7403"
      },
      "execution_count": 28,
      "outputs": [
        {
          "output_type": "stream",
          "name": "stderr",
          "text": [
            "WARNING:langchain_text_splitters.base:Created a chunk of size 1017, which is longer than the specified 700\n",
            "WARNING:langchain_text_splitters.base:Created a chunk of size 806, which is longer than the specified 700\n"
          ]
        },
        {
          "output_type": "execute_result",
          "data": {
            "text/plain": [
              "66"
            ]
          },
          "metadata": {},
          "execution_count": 28
        }
      ]
    },
    {
      "cell_type": "code",
      "source": [
        "# Let's checkout some of the chunks!\n",
        "for i in range(0, 3):\n",
        "  print(\"Chunk\", str(i+1))\n",
        "  print(\"----------------------------\")\n",
        "  print(docs[i])\n",
        "  print(\"\")"
      ],
      "metadata": {
        "id": "XPgwoO2w4-Lr",
        "colab": {
          "base_uri": "https://localhost:8080/"
        },
        "outputId": "d74faecf-05eb-4218-bb1e-8c7b3d52ed20"
      },
      "execution_count": 29,
      "outputs": [
        {
          "output_type": "stream",
          "name": "stdout",
          "text": [
            "Chunk 1\n",
            "----------------------------\n",
            "* Show Source\n",
            "\n",
            "English\n",
            "\n",
            "  * Chinese (Simplified)\n",
            "  * Chinese (Traditional)\n",
            "  * Italian\n",
            "  * Spanish\n",
            "\n",
            "# Submitting patches: the essential guide to getting your code into the\n",
            "kernel¶\n",
            "\n",
            "For a person or company who wishes to submit a change to the Linux kernel, the\n",
            "process can sometimes be daunting if you’re not familiar with “the system.”\n",
            "This text is a collection of suggestions which can greatly increase the\n",
            "chances of your change being accepted.\n",
            "\n",
            "Chunk 2\n",
            "----------------------------\n",
            "This document contains a large number of suggestions in a relatively terse\n",
            "format. For detailed information on how the kernel development process works,\n",
            "see A guide to the Kernel Development Process. Also, read Linux Kernel patch\n",
            "submission checklist for a list of items to check before submitting code. For\n",
            "device tree binding patches, read Submitting Devicetree (DT) binding patches.\n",
            "\n",
            "This documentation assumes that you’re using `git` to prepare your patches. If\n",
            "you’re unfamiliar with `git`, you would be well-advised to learn how to use\n",
            "it, it will make your life as a kernel developer and in general much easier.\n",
            "\n",
            "Chunk 3\n",
            "----------------------------\n",
            "Some subsystems and maintainer trees have additional information about their\n",
            "workflow and expectations, see Documentation/process/maintainer-handbooks.rst.\n",
            "\n",
            "## Obtain a current source tree¶\n",
            "\n",
            "If you do not have a repository with the current kernel source handy, use\n",
            "`git` to obtain one. You’ll want to start with the mainline repository, which\n",
            "can be grabbed with:\n",
            "\n",
            "    \n",
            "    \n",
            "    git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git\n",
            "\n"
          ]
        }
      ]
    },
    {
      "cell_type": "code",
      "source": [
        "# Let's take care of some of the formatting so it doesn't conflict with our\n",
        "# typical prompt template structure\n",
        "docs = [x.replace('#', '-') for x in docs]\n",
        "print(docs[2])"
      ],
      "metadata": {
        "id": "Sl5ib7UU5dKd",
        "colab": {
          "base_uri": "https://localhost:8080/"
        },
        "outputId": "6a1f6f8f-6930-4726-b758-028d2688b606"
      },
      "execution_count": 30,
      "outputs": [
        {
          "output_type": "stream",
          "name": "stdout",
          "text": [
            "Some subsystems and maintainer trees have additional information about their\n",
            "workflow and expectations, see Documentation/process/maintainer-handbooks.rst.\n",
            "\n",
            "-- Obtain a current source tree¶\n",
            "\n",
            "If you do not have a repository with the current kernel source handy, use\n",
            "`git` to obtain one. You’ll want to start with the mainline repository, which\n",
            "can be grabbed with:\n",
            "\n",
            "    \n",
            "    \n",
            "    git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git\n"
          ]
        }
      ]
    },
    {
      "cell_type": "code",
      "source": [
        "# Now we need to embed these documents and put them into a \"vector store\" or\n",
        "# \"vector db\" that we will use for semantic search and retrieval.\n",
        "\n",
        "# Function to get embeddings from Prediction Guard in batches\n",
        "def embed_text_column(df, text_column=\"text\", batch_size=20):\n",
        "    def embed_batch(batch):\n",
        "        embeddings = []\n",
        "        for i in range(0, len(batch), batch_size):\n",
        "            chunk = batch[i:i+batch_size]\n",
        "            response = client.embeddings.create(\n",
        "                model=\"multilingual-e5-large-instruct\",\n",
        "                input=chunk,\n",
        "                truncate=True\n",
        "            )\n",
        "\n",
        "            if \"data\" in response:\n",
        "                chunk_embeddings = [item[\"embedding\"] for item in response[\"data\"] if \"embedding\" in item]\n",
        "                embeddings.extend(chunk_embeddings)\n",
        "            else:\n",
        "                raise Exception(f\"Error in embedding response: {response}\")\n",
        "        return [np.array(embedding) for embedding in embeddings]\n",
        "\n",
        "    # Embed the documents in smaller batches\n",
        "    embeddings = embed_batch(df[text_column].tolist())\n",
        "\n",
        "    # Verify the number of embeddings matches the number of documents\n",
        "    if len(embeddings) != len(df):\n",
        "        raise ValueError(\"The number of embeddings does not match the number of documents\")\n",
        "\n",
        "    # Add embeddings to the dataframe as a single column named \"vector\"\n",
        "    df[\"vector\"] = embeddings\n",
        "\n",
        "    return df\n",
        "\n",
        "def embed(sentence):\n",
        "    response = client.embeddings.create(\n",
        "        model=\"multilingual-e5-large-instruct\",\n",
        "        input=sentence,\n",
        "        truncate=True\n",
        "    )\n",
        "    if \"data\" in response:\n",
        "        embedding = response[\"data\"][0][\"embedding\"]\n",
        "        return embedding\n",
        "    else:\n",
        "        raise Exception(f\"Error in embedding response: {response}\")\n",
        "\n",
        "# LanceDB setup\n",
        "uri = \".lancedb\"\n",
        "if os.path.exists(uri):\n",
        "    shutil.rmtree(uri)\n",
        "os.mkdir(uri)\n",
        "db = lancedb.connect(uri)\n",
        "\n",
        "# Create a dataframe with the chunk ids and chunks\n",
        "metadata = []\n",
        "for i in range(len(docs)):\n",
        "    metadata.append([i, docs[i]])\n",
        "doc_df = pd.DataFrame(metadata, columns=[\"chunk\", \"text\"])\n",
        "print(doc_df.head())"
      ],
      "metadata": {
        "id": "-rsGYSGR5w95",
        "colab": {
          "base_uri": "https://localhost:8080/"
        },
        "outputId": "28977aea-08df-471d-df8f-e3a4619c58a4"
      },
      "execution_count": 33,
      "outputs": [
        {
          "output_type": "stream",
          "name": "stdout",
          "text": [
            "   chunk                                               text\n",
            "0      0  * Show Source\\n\\nEnglish\\n\\n  * Chinese (Simpl...\n",
            "1      1  This document contains a large number of sugge...\n",
            "2      2  Some subsystems and maintainer trees have addi...\n",
            "3      3  Note, however, that you may not want to develo...\n",
            "4      4  Describe user-visible impact. Straight up cras...\n"
          ]
        }
      ]
    },
    {
      "cell_type": "code",
      "source": [
        "data=embed_text_column(doc_df)"
      ],
      "metadata": {
        "id": "JgsIA1un7Pyq"
      },
      "execution_count": 34,
      "outputs": []
    },
    {
      "cell_type": "code",
      "source": [
        "# Create the DB table and add the records\n",
        "if \"linux\" in db.table_names():\n",
        "    db.drop_table(\"linux\")\n",
        "\n",
        "table = db.create_table(\"linux\", data=data)"
      ],
      "metadata": {
        "id": "F022vhos7hth"
      },
      "execution_count": 35,
      "outputs": []
    },
    {
      "cell_type": "code",
      "source": [
        "# Let's try to match a query to one of our documents.\n",
        "message = \"How many problems should be solved per patch?\"\n",
        "results = table.search(embed(message)).limit(5).to_pandas()\n",
        "results.head()"
      ],
      "metadata": {
        "id": "daHLa4oH7q10",
        "colab": {
          "base_uri": "https://localhost:8080/",
          "height": 226
        },
        "outputId": "bb78f6b1-358d-4397-e694-ea2ffee489c5"
      },
      "execution_count": 37,
      "outputs": [
        {
          "output_type": "execute_result",
          "data": {
            "text/plain": [
              "   chunk                                               text  \\\n",
              "0     15  When dividing your change into a series of pat...   \n",
              "1      6  The maintainer will thank you if you write you...   \n",
              "2     17  Check your patches with the patch style checke...   \n",
              "3     14  On the other hand, if you make a single change...   \n",
              "4     55  If a patch fixes a compile failure, it may not...   \n",
              "\n",
              "                                              vector  _distance  \n",
              "0  [0.0004274976, 0.020138724, -0.012549005, -0.0...   0.291016  \n",
              "1  [0.009361901, 0.028679557, -0.019474851, -0.02...   0.298232  \n",
              "2  [-0.006910427, 0.004181309, -0.02513793, -0.00...   0.298650  \n",
              "3  [0.0046620346, 0.01853433, -0.027573884, -0.02...   0.299950  \n",
              "4  [0.01613208, 0.015890308, -0.022159725, -0.031...   0.317525  "
            ],
            "text/html": [
              "\n",
              "  <div id=\"df-98082eba-4ca1-47a2-a10b-0549b13e000d\" class=\"colab-df-container\">\n",
              "    <div>\n",
              "<style scoped>\n",
              "    .dataframe tbody tr th:only-of-type {\n",
              "        vertical-align: middle;\n",
              "    }\n",
              "\n",
              "    .dataframe tbody tr th {\n",
              "        vertical-align: top;\n",
              "    }\n",
              "\n",
              "    .dataframe thead th {\n",
              "        text-align: right;\n",
              "    }\n",
              "</style>\n",
              "<table border=\"1\" class=\"dataframe\">\n",
              "  <thead>\n",
              "    <tr style=\"text-align: right;\">\n",
              "      <th></th>\n",
              "      <th>chunk</th>\n",
              "      <th>text</th>\n",
              "      <th>vector</th>\n",
              "      <th>_distance</th>\n",
              "    </tr>\n",
              "  </thead>\n",
              "  <tbody>\n",
              "    <tr>\n",
              "      <th>0</th>\n",
              "      <td>15</td>\n",
              "      <td>When dividing your change into a series of pat...</td>\n",
              "      <td>[0.0004274976, 0.020138724, -0.012549005, -0.0...</td>\n",
              "      <td>0.291016</td>\n",
              "    </tr>\n",
              "    <tr>\n",
              "      <th>1</th>\n",
              "      <td>6</td>\n",
              "      <td>The maintainer will thank you if you write you...</td>\n",
              "      <td>[0.009361901, 0.028679557, -0.019474851, -0.02...</td>\n",
              "      <td>0.298232</td>\n",
              "    </tr>\n",
              "    <tr>\n",
              "      <th>2</th>\n",
              "      <td>17</td>\n",
              "      <td>Check your patches with the patch style checke...</td>\n",
              "      <td>[-0.006910427, 0.004181309, -0.02513793, -0.00...</td>\n",
              "      <td>0.298650</td>\n",
              "    </tr>\n",
              "    <tr>\n",
              "      <th>3</th>\n",
              "      <td>14</td>\n",
              "      <td>On the other hand, if you make a single change...</td>\n",
              "      <td>[0.0046620346, 0.01853433, -0.027573884, -0.02...</td>\n",
              "      <td>0.299950</td>\n",
              "    </tr>\n",
              "    <tr>\n",
              "      <th>4</th>\n",
              "      <td>55</td>\n",
              "      <td>If a patch fixes a compile failure, it may not...</td>\n",
              "      <td>[0.01613208, 0.015890308, -0.022159725, -0.031...</td>\n",
              "      <td>0.317525</td>\n",
              "    </tr>\n",
              "  </tbody>\n",
              "</table>\n",
              "</div>\n",
              "    <div class=\"colab-df-buttons\">\n",
              "\n",
              "  <div class=\"colab-df-container\">\n",
              "    <button class=\"colab-df-convert\" onclick=\"convertToInteractive('df-98082eba-4ca1-47a2-a10b-0549b13e000d')\"\n",
              "            title=\"Convert this dataframe to an interactive table.\"\n",
              "            style=\"display:none;\">\n",
              "\n",
              "  <svg xmlns=\"http://www.w3.org/2000/svg\" height=\"24px\" viewBox=\"0 -960 960 960\">\n",
              "    <path d=\"M120-120v-720h720v720H120Zm60-500h600v-160H180v160Zm220 220h160v-160H400v160Zm0 220h160v-160H400v160ZM180-400h160v-160H180v160Zm440 0h160v-160H620v160ZM180-180h160v-160H180v160Zm440 0h160v-160H620v160Z\"/>\n",
              "  </svg>\n",
              "    </button>\n",
              "\n",
              "  <style>\n",
              "    .colab-df-container {\n",
              "      display:flex;\n",
              "      gap: 12px;\n",
              "    }\n",
              "\n",
              "    .colab-df-convert {\n",
              "      background-color: #E8F0FE;\n",
              "      border: none;\n",
              "      border-radius: 50%;\n",
              "      cursor: pointer;\n",
              "      display: none;\n",
              "      fill: #1967D2;\n",
              "      height: 32px;\n",
              "      padding: 0 0 0 0;\n",
              "      width: 32px;\n",
              "    }\n",
              "\n",
              "    .colab-df-convert:hover {\n",
              "      background-color: #E2EBFA;\n",
              "      box-shadow: 0px 1px 2px rgba(60, 64, 67, 0.3), 0px 1px 3px 1px rgba(60, 64, 67, 0.15);\n",
              "      fill: #174EA6;\n",
              "    }\n",
              "\n",
              "    .colab-df-buttons div {\n",
              "      margin-bottom: 4px;\n",
              "    }\n",
              "\n",
              "    [theme=dark] .colab-df-convert {\n",
              "      background-color: #3B4455;\n",
              "      fill: #D2E3FC;\n",
              "    }\n",
              "\n",
              "    [theme=dark] .colab-df-convert:hover {\n",
              "      background-color: #434B5C;\n",
              "      box-shadow: 0px 1px 3px 1px rgba(0, 0, 0, 0.15);\n",
              "      filter: drop-shadow(0px 1px 2px rgba(0, 0, 0, 0.3));\n",
              "      fill: #FFFFFF;\n",
              "    }\n",
              "  </style>\n",
              "\n",
              "    <script>\n",
              "      const buttonEl =\n",
              "        document.querySelector('#df-98082eba-4ca1-47a2-a10b-0549b13e000d button.colab-df-convert');\n",
              "      buttonEl.style.display =\n",
              "        google.colab.kernel.accessAllowed ? 'block' : 'none';\n",
              "\n",
              "      async function convertToInteractive(key) {\n",
              "        const element = document.querySelector('#df-98082eba-4ca1-47a2-a10b-0549b13e000d');\n",
              "        const dataTable =\n",
              "          await google.colab.kernel.invokeFunction('convertToInteractive',\n",
              "                                                    [key], {});\n",
              "        if (!dataTable) return;\n",
              "\n",
              "        const docLinkHtml = 'Like what you see? Visit the ' +\n",
              "          '<a target=\"_blank\" href=https://colab.research.google.com/notebooks/data_table.ipynb>data table notebook</a>'\n",
              "          + ' to learn more about interactive tables.';\n",
              "        element.innerHTML = '';\n",
              "        dataTable['output_type'] = 'display_data';\n",
              "        await google.colab.output.renderOutput(dataTable, element);\n",
              "        const docLink = document.createElement('div');\n",
              "        docLink.innerHTML = docLinkHtml;\n",
              "        element.appendChild(docLink);\n",
              "      }\n",
              "    </script>\n",
              "  </div>\n",
              "\n",
              "\n",
              "<div id=\"df-6334cca2-e087-4940-bb02-24e800b238c0\">\n",
              "  <button class=\"colab-df-quickchart\" onclick=\"quickchart('df-6334cca2-e087-4940-bb02-24e800b238c0')\"\n",
              "            title=\"Suggest charts\"\n",
              "            style=\"display:none;\">\n",
              "\n",
              "<svg xmlns=\"http://www.w3.org/2000/svg\" height=\"24px\"viewBox=\"0 0 24 24\"\n",
              "     width=\"24px\">\n",
              "    <g>\n",
              "        <path d=\"M19 3H5c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h14c1.1 0 2-.9 2-2V5c0-1.1-.9-2-2-2zM9 17H7v-7h2v7zm4 0h-2V7h2v10zm4 0h-2v-4h2v4z\"/>\n",
              "    </g>\n",
              "</svg>\n",
              "  </button>\n",
              "\n",
              "<style>\n",
              "  .colab-df-quickchart {\n",
              "      --bg-color: #E8F0FE;\n",
              "      --fill-color: #1967D2;\n",
              "      --hover-bg-color: #E2EBFA;\n",
              "      --hover-fill-color: #174EA6;\n",
              "      --disabled-fill-color: #AAA;\n",
              "      --disabled-bg-color: #DDD;\n",
              "  }\n",
              "\n",
              "  [theme=dark] .colab-df-quickchart {\n",
              "      --bg-color: #3B4455;\n",
              "      --fill-color: #D2E3FC;\n",
              "      --hover-bg-color: #434B5C;\n",
              "      --hover-fill-color: #FFFFFF;\n",
              "      --disabled-bg-color: #3B4455;\n",
              "      --disabled-fill-color: #666;\n",
              "  }\n",
              "\n",
              "  .colab-df-quickchart {\n",
              "    background-color: var(--bg-color);\n",
              "    border: none;\n",
              "    border-radius: 50%;\n",
              "    cursor: pointer;\n",
              "    display: none;\n",
              "    fill: var(--fill-color);\n",
              "    height: 32px;\n",
              "    padding: 0;\n",
              "    width: 32px;\n",
              "  }\n",
              "\n",
              "  .colab-df-quickchart:hover {\n",
              "    background-color: var(--hover-bg-color);\n",
              "    box-shadow: 0 1px 2px rgba(60, 64, 67, 0.3), 0 1px 3px 1px rgba(60, 64, 67, 0.15);\n",
              "    fill: var(--button-hover-fill-color);\n",
              "  }\n",
              "\n",
              "  .colab-df-quickchart-complete:disabled,\n",
              "  .colab-df-quickchart-complete:disabled:hover {\n",
              "    background-color: var(--disabled-bg-color);\n",
              "    fill: var(--disabled-fill-color);\n",
              "    box-shadow: none;\n",
              "  }\n",
              "\n",
              "  .colab-df-spinner {\n",
              "    border: 2px solid var(--fill-color);\n",
              "    border-color: transparent;\n",
              "    border-bottom-color: var(--fill-color);\n",
              "    animation:\n",
              "      spin 1s steps(1) infinite;\n",
              "  }\n",
              "\n",
              "  @keyframes spin {\n",
              "    0% {\n",
              "      border-color: transparent;\n",
              "      border-bottom-color: var(--fill-color);\n",
              "      border-left-color: var(--fill-color);\n",
              "    }\n",
              "    20% {\n",
              "      border-color: transparent;\n",
              "      border-left-color: var(--fill-color);\n",
              "      border-top-color: var(--fill-color);\n",
              "    }\n",
              "    30% {\n",
              "      border-color: transparent;\n",
              "      border-left-color: var(--fill-color);\n",
              "      border-top-color: var(--fill-color);\n",
              "      border-right-color: var(--fill-color);\n",
              "    }\n",
              "    40% {\n",
              "      border-color: transparent;\n",
              "      border-right-color: var(--fill-color);\n",
              "      border-top-color: var(--fill-color);\n",
              "    }\n",
              "    60% {\n",
              "      border-color: transparent;\n",
              "      border-right-color: var(--fill-color);\n",
              "    }\n",
              "    80% {\n",
              "      border-color: transparent;\n",
              "      border-right-color: var(--fill-color);\n",
              "      border-bottom-color: var(--fill-color);\n",
              "    }\n",
              "    90% {\n",
              "      border-color: transparent;\n",
              "      border-bottom-color: var(--fill-color);\n",
              "    }\n",
              "  }\n",
              "</style>\n",
              "\n",
              "  <script>\n",
              "    async function quickchart(key) {\n",
              "      const quickchartButtonEl =\n",
              "        document.querySelector('#' + key + ' button');\n",
              "      quickchartButtonEl.disabled = true;  // To prevent multiple clicks.\n",
              "      quickchartButtonEl.classList.add('colab-df-spinner');\n",
              "      try {\n",
              "        const charts = await google.colab.kernel.invokeFunction(\n",
              "            'suggestCharts', [key], {});\n",
              "      } catch (error) {\n",
              "        console.error('Error during call to suggestCharts:', error);\n",
              "      }\n",
              "      quickchartButtonEl.classList.remove('colab-df-spinner');\n",
              "      quickchartButtonEl.classList.add('colab-df-quickchart-complete');\n",
              "    }\n",
              "    (() => {\n",
              "      let quickchartButtonEl =\n",
              "        document.querySelector('#df-6334cca2-e087-4940-bb02-24e800b238c0 button');\n",
              "      quickchartButtonEl.style.display =\n",
              "        google.colab.kernel.accessAllowed ? 'block' : 'none';\n",
              "    })();\n",
              "  </script>\n",
              "</div>\n",
              "\n",
              "    </div>\n",
              "  </div>\n"
            ],
            "application/vnd.google.colaboratory.intrinsic+json": {
              "type": "dataframe",
              "variable_name": "results",
              "summary": "{\n  \"name\": \"results\",\n  \"rows\": 5,\n  \"fields\": [\n    {\n      \"column\": \"chunk\",\n      \"properties\": {\n        \"dtype\": \"number\",\n        \"std\": 19,\n        \"min\": 6,\n        \"max\": 55,\n        \"num_unique_values\": 5,\n        \"samples\": [\n          6,\n          55,\n          17\n        ],\n        \"semantic_type\": \"\",\n        \"description\": \"\"\n      }\n    },\n    {\n      \"column\": \"text\",\n      \"properties\": {\n        \"dtype\": \"string\",\n        \"num_unique_values\": 5,\n        \"samples\": [\n          \"The maintainer will thank you if you write your patch description in a form\\nwhich can be easily pulled into Linux\\u2019s source code management system, `git`,\\nas a \\u201ccommit log\\u201d. See The canonical patch format.\\n\\nSolve only one problem per patch. If your description starts to get long,\\nthat\\u2019s a sign that you probably need to split up your patch. See Separate your\\nchanges.\",\n          \"If a patch fixes a compile failure, it may not be necessary to include _all_\\nof the compile failures; just enough that it is likely that someone searching\\nfor the patch can find it. As in the `summary phrase`, it is important to be\\nboth succinct as well as descriptive.\\n\\nThe `---` marker line serves the essential purpose of marking for patch\\nhandling tools where the changelog message ends.\",\n          \"Check your patches with the patch style checker prior to submission\\n(scripts/checkpatch.pl). Note, though, that the style checker should be viewed\\nas a guide, not as a replacement for human judgment. If your code looks better\\nwith a violation then its probably best left alone.\\n\\nThe checker reports at three levels:\\n\\n    \\n\\n  * ERROR: things that are very likely to be wrong\\n\\n  * WARNING: things requiring careful review\\n\\n  * CHECK: things requiring thought\\n\\nYou should be able to justify all violations that remain in your patch.\\n\\n-- Select the recipients for your patch\\u00b6\"\n        ],\n        \"semantic_type\": \"\",\n        \"description\": \"\"\n      }\n    },\n    {\n      \"column\": \"vector\",\n      \"properties\": {\n        \"dtype\": \"object\",\n        \"semantic_type\": \"\",\n        \"description\": \"\"\n      }\n    },\n    {\n      \"column\": \"_distance\",\n      \"properties\": {\n        \"dtype\": \"float32\",\n        \"num_unique_values\": 5,\n        \"samples\": [\n          0.298231840133667,\n          0.3175254166126251,\n          0.29864951968193054\n        ],\n        \"semantic_type\": \"\",\n        \"description\": \"\"\n      }\n    }\n  ]\n}"
            }
          },
          "metadata": {},
          "execution_count": 37
        }
      ]
    },
    {
      "cell_type": "code",
      "source": [
        "# Now let's augment our Q&A prompt with this external knowledge on-the-fly!!!\n",
        "template = \"\"\"Read the below input context and respond with a short answer to the given question. Use only the information in the below input to answer the question. If you cannot answer the question, respond with \"Sorry, I can't find an answer, but you might try looking in the following resource.\"\n",
        "\n",
        "Context: {context}\n",
        "\n",
        "Question: {question}\n",
        "\n",
        "Answer:\n",
        "\"\"\"\n",
        "qa_prompt = PromptTemplate(\n",
        "    input_variables=[\"context\", \"question\"],\n",
        "    template=template,\n",
        ")\n",
        "\n",
        "def rag_answer(message):\n",
        "\n",
        "  # Search the for relevant context\n",
        "  results = table.search(embed(message)).limit(5).to_pandas()\n",
        "  results.sort_values(by=['_distance'], inplace=True, ascending=True)\n",
        "  doc_use = results['text'].values[0]\n",
        "\n",
        "  # Augment the prompt with the context\n",
        "  prompt = qa_prompt.format(context=doc_use, question=message)\n",
        "\n",
        "  # Get a response\n",
        "  result = client.chat.completions.create(\n",
        "      model=\"Hermes-3-Llama-3.1-8B\",\n",
        "      messages=[{\"role\": \"user\", \"content\": prompt}]\n",
        "  )\n",
        "\n",
        "  return result['choices'][0]['message']['content']\n"
      ],
      "metadata": {
        "id": "IDscT_858T4A"
      },
      "execution_count": 40,
      "outputs": []
    },
    {
      "cell_type": "code",
      "source": [
        "response = rag_answer(\"How many problems should be solved in a single patch?\")\n",
        "\n",
        "print('')\n",
        "print(\"RESPONSE:\", response)"
      ],
      "metadata": {
        "id": "pRo91E2w9adt",
        "colab": {
          "base_uri": "https://localhost:8080/"
        },
        "outputId": "59addf44-fe95-40f7-fe8f-e9e81eae55ce"
      },
      "execution_count": 41,
      "outputs": [
        {
          "output_type": "stream",
          "name": "stdout",
          "text": [
            "\n",
            "RESPONSE: A single patch should solve a single logical change. It should be easily understood and verifiable by reviewers, and able to stand on its own merits.\n"
          ]
        }
      ]
    },
    {
      "cell_type": "code",
      "source": [],
      "metadata": {
        "id": "gVgUfgorZR_F"
      },
      "execution_count": null,
      "outputs": []
    }
  ]
}