resolved typos, awaiting for approval

example/extract/extract_pdf.ipynb

@@ -220,27 +220,34 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "instruction=\"\"\"Generate one question and its corresponding answer based on the last context in the last \\\n",
+    "example. Follow the format of the examples below to include context, question, and answer in the response\"\"\"\n",
+    "context=\"\"\"In 1948, Claude E. Shannon published A Mathematical Theory of\\nCommunication (Shannon, 1948) establishing the theory of\\ninformation. In his article, Shannon introduced the concept of\\ninformation entropy for the first time. We will begin our journey here.\"\"\"\n",
+    "question=\"\"\"Who published A Mathematical Theory of Communication in 1948?\"\"\"\n",
+    "answer=\"\"\"Claude E. Shannon.\"\"\"\n",
+    "\n",
     "guided_prompt = PromptTemplate(\n",
-    "    instruction=\"\"\"Generate one question and its corresponding answer based on the last context in the last\n",
-    "    example. Follow the format of the examples below to include context, question, and answer in the response\"\"\",\n",
+    "    instruction=instruction,\n",
     "    few_shot_prompt=[Context(\n",
-    "        context=\"In 1948, Claude E. Shannon published A Mathematical Theory of\\nCommunication (Shannon, 1948) establishing the theory of\\ninformation. In his article, Shannon introduced the concept of\\ninformation entropy for the first time. We will begin our journey here.\"\"\",\n",
-    "        question=\"Who published A Mathematical Theory of Communication in 1948?\"\"\",\n",
-    "        answer=\"Claude E. Shannon.\"\"\"\n",
+    "        context=context,\n",
+    "        question=question,\n",
+    "        answer=answer\n",
     "    )]\n",
     ")\n",
+    "\n",
     "input_data = [\n",
-    "        Context(\n",
-    "            context=p[:1000],\n",
-    "            question=\"\",\n",
-    "            answer=\"\",\n",
-    "        )\n",
-    "        for p in contexts\n",
+    "    Context(\n",
+    "        context=p[:1000],\n",
+    "        question=\"\"\"\"\"\",\n",
+    "        answer=\"\"\"\"\"\",\n",
+    "    )\n",
+    "    for p in contexts\n",
     "]\n"
    ]
   },
   {
    "cell_type": "markdown",
+   "id": "8f7be007",
    "metadata": {},
    "source": [
     "### Run the model\n",
@@ -540,6 +547,12 @@
     "    <img src=\"../image/cambioml_logo_large.png\" style=\"height: 100px; display: block; margin-left: auto; margin-right: auto;\"/>\n",
     "</a>"
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "9d0ada9b",
+   "metadata": {},
+   "source": []
   }
  ],
  "metadata": {

example/llm/sagemaker_deploy_mistral.ipynb

@@ -703,7 +703,7 @@
     "\n",
     "<a href=\"https://www.cambioml.com/\" title=\"Title\">\n",
     "    <img src=\"../image/cambioml_logo_large.png\" style=\"height: 100px; display: block; margin-left: auto; margin-right: auto;\"/>\n",
-    "</a>\n"
+    "</a>"
    ]
   }
  ],

example/pipeline/pipeline_pdf.ipynb

@@ -139,13 +139,19 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "instruction=\"\"\"Generate one question and its corresponding answer based on the last context in the last \\\n",
+    "example. Follow the format of the examples below to include context, question, and answer in the response\"\"\"\n",
+    "\n",
+    "context=\"\"\"In 1948, Claude E. Shannon published A Mathematical Theory of\\nCommunication (Shannon, 1948) establishing the theory of\\ninformation. In his article, Shannon introduced the concept of\\ninformation entropy for the first time. We will begin our journey here.\"\"\"\n",
+    "question=\"\"\"Who published A Mathematical Theory of Communication in 1948?\"\"\"\n",
+    "answer=\"\"\"Claude E. Shannon.\"\"\"\n",
+    "\n",
     "guided_prompt = PromptTemplate(\n",
-    "    instruction=\"\"\"Generate one question and its corresponding answer based on the last context in the last\n",
-    "    example. Follow the format of the examples below to include context, question, and answer in the response\"\"\",\n",
+    "    instruction=instruction,\n",
     "    few_shot_prompt=[Context(\n",
-    "        context=\"In 1948, Claude E. Shannon published A Mathematical Theory of\\nCommunication (Shannon, 1948) establishing the theory of\\ninformation. In his article, Shannon introduced the concept of\\ninformation entropy for the first time. We will begin our journey here.\"\"\",\n",
-    "        question=\"Who published A Mathematical Theory of Communication in 1948?\"\"\",\n",
-    "        answer=\"Claude E. Shannon.\"\"\"\n",
+    "        context=context,\n",
+    "        question=question,\n",
+    "        answer=answer\n",
     "    )]\n",
     ")\n"
    ]

example/pipeline/pipeline_pdf_extract_transform.ipynb

@@ -149,14 +149,20 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "instruction=\"\"\"Generate one question and its corresponding answer based on the last context in the last \\\n",
+    "example. Follow the format of the examples below to include context, question, and answer in the response\"\"\"\n",
+    "\n",
+    "context=\"\"\"In 1948, Claude E. Shannon published A Mathematical Theory of\\nCommunication (Shannon, 1948) establishing the theory of\\ninformation. In his article, Shannon introduced the concept of\\ninformation entropy for the first time. We will begin our journey here.\"\"\"\n",
+    "question=\"\"\"Who published A Mathematical Theory of Communication in 1948?\"\"\"\n",
+    "answer=\"\"\"Claude E. Shannon.\"\"\"\n",
+    "\n",
     "guided_prompt = PromptTemplate(\n",
-    "    instruction=\"\"\"Generate one question and its corresponding answer based on the last context in the last\n",
-    "    example. Follow the format of the examples below to include context, question, and answer in the response\"\"\",\n",
+    "    instruction=instruction,\n",
     "    few_shot_prompt=[\n",
     "        Context(\n",
-    "            context=\"In 1948, Claude E. Shannon published A Mathematical Theory of\\nCommunication (Shannon, 1948) establishing the theory of\\ninformation. In his article, Shannon introduced the concept of\\ninformation entropy for the first time. We will begin our journey here.\",\n",
-    "            question=\"Who published A Mathematical Theory of Communication in 1948?\",\n",
-    "            answer=\"Claude E. Shannon.\",\n",
+    "            context=context,\n",
+    "            question=question,\n",
+    "            answer=answer,\n",
     "        ),\n",
     "        \n",
     "])"

example/rater/bedrock_classification.ipynb

@@ -132,15 +132,15 @@
    "outputs": [],
    "source": [
     "raw_input = [\n",
-    "    (\"The Pacific Ocean is the largest and deepest of Earth's oceanic divisions. It extends from the Arctic Ocean in the north to the Southern Ocean in the south.\",\n",
-    "     \"What is the largest ocean on Earth?\",\n",
-    "     \"The largest ocean on Earth is the Pacific Ocean.\"), # correct\n",
-    "    (\"Shakespeare, a renowned English playwright and poet, wrote 39 plays during his lifetime. His works include famous plays like 'Hamlet' and 'Romeo and Juliet'.\",\n",
-    "     \"How many plays did Shakespeare write?\",\n",
-    "     \"Shakespeare wrote 39 plays.\"), # correct\n",
-    "    (\"The human brain is an intricate organ responsible for intelligence, memory, and emotions. It is made up of approximately 86 billion neurons.\",\n",
-    "     \"What is the human brain responsible for?\",\n",
-    "     \"The human brain is responsible for physical movement.\"), # incorrect\n",
+    "    (\"\"\"The Pacific Ocean is the largest and deepest of Earth's oceanic divisions. It extends from the Arctic Ocean in the north to the Southern Ocean in the south.\"\"\",\n",
+    "     \"\"\"What is the largest ocean on Earth?\"\"\",\n",
+    "     \"\"\"The largest ocean on Earth is the Pacific Ocean.\"\"\"), # correct\n",
+    "    (\"\"\"Shakespeare, a renowned English playwright and poet, wrote 39 plays during his lifetime. His works include famous plays like 'Hamlet' and 'Romeo and Juliet'.\"\"\",\n",
+    "     \"\"\"How many plays did Shakespeare write?\"\"\",\n",
+    "     \"\"\"Shakespeare wrote 39 plays.\"\"\"), # correct\n",
+    "    (\"\"\"The human brain is an intricate organ responsible for intelligence, memory, and emotions. It is made up of approximately 86 billion neurons.\"\"\",\n",
+    "     \"\"\"What is the human brain responsible for?\"\"\",\n",
+    "     \"\"\"The human brain is responsible for physical movement.\"\"\"), # incorrect\n",
     "]"
    ]
   },

example/rater/classification.ipynb

@@ -89,15 +89,15 @@
    "outputs": [],
    "source": [
     "raw_input = [\n",
-    "    (\"The Pacific Ocean is the largest and deepest of Earth's oceanic divisions. It extends from the Arctic Ocean in the north to the Southern Ocean in the south.\",\n",
-    "     \"What is the largest ocean on Earth?\",\n",
-    "     \"The largest ocean on Earth is the Pacific Ocean.\"), # correct\n",
-    "    (\"Shakespeare, a renowned English playwright and poet, wrote 39 plays during his lifetime. His works include famous plays like 'Hamlet' and 'Romeo and Juliet'.\",\n",
-    "     \"How many plays did Shakespeare write?\",\n",
-    "     \"Shakespeare wrote 31 plays.\"), # incorrect\n",
-    "    (\"The human brain is an intricate organ responsible for intelligence, memory, and emotions. It is made up of approximately 86 billion neurons.\",\n",
-    "     \"What is the human brain responsible for?\",\n",
-    "     \"The human brain is responsible for physical movement.\"), # incorrect\n",
+    "    (\"\"\"The Pacific Ocean is the largest and deepest of Earth's oceanic divisions. It extends from the Arctic Ocean in the north to the Southern Ocean in the south.\"\"\",\n",
+    "     \"\"\"What is the largest ocean on Earth?\"\"\",\n",
+    "     \"\"\"The largest ocean on Earth is the Pacific Ocean.\"\"\"), # correct\n",
+    "    (\"\"\"Shakespeare, a renowned English playwright and poet, wrote 39 plays during his lifetime. His works include famous plays like 'Hamlet' and 'Romeo and Juliet'.\"\"\",\n",
+    "     \"\"\"How many plays did Shakespeare write?\"\"\",\n",
+    "     \"\"\"Shakespeare wrote 31 plays.\"\"\"), # incorrect\n",
+    "    (\"\"\"The human brain is an intricate organ responsible for intelligence, memory, and emotions. It is made up of approximately 86 billion neurons.\"\"\",\n",
+    "     \"\"\"What is the human brain responsible for?\"\"\",\n",
+    "     \"\"\"The human brain is responsible for physical movement.\"\"\"), # incorrect\n",
     "]\n",
     "\n",
     "data = [\n",

example/rater/generated_answer.ipynb

@@ -90,18 +90,18 @@
    "outputs": [],
    "source": [
     "raw_input = [\n",
-    "    (\"Reddit is an American social news aggregation, content rating, and discussion website. Registered users submit content to the site such as links, text posts, images, and videos, which are then voted up or down by other members.\",\n",
-    "     \"What type of content can users submit on Reddit?\",\n",
-    "     \"Users can only post text on Reddit.\",\n",
-    "     \"Users on Reddit can submit various types of content including links, text posts, images, and videos.\"), # Better\n",
-    "    (\"League of Legends (LoL), commonly referred to as League, is a 2009 multiplayer online battle arena video game developed and published by Riot Games. \",\n",
-    "     \"When was League of Legends released?\",\n",
-    "     \"League of Legends was released in 2009.\",\n",
-    "     \"League of Legends was released in the early 2000s.\"), # Worse\n",
-    "    (\"Vitamin C (also known as ascorbic acid and ascorbate) is a water-soluble vitamin found in citrus and other fruits, berries and vegetables, also sold as a dietary supplement and as a topical serum ingredient to treat melasma (dark pigment spots) and wrinkles on the face.\",\n",
-    "     \"Is Vitamin C water-soluble?\",\n",
-    "     \"Yes, Vitamin C is a very water-soluble vitamin.\",\n",
-    "     \"Yes, Vitamin C can be dissolved in water well.\"), # Equally good\n",
+    "    (\"\"\"Reddit is an American social news aggregation, content rating, and discussion website. Registered users submit content to the site such as links, text posts, images, and videos, which are then voted up or down by other members.\"\"\",\n",
+    "     \"\"\"What type of content can users submit on Reddit?\"\"\",\n",
+    "     \"\"\"Users can only post text on Reddit.\"\"\",\n",
+    "     \"\"\"Users on Reddit can submit various types of content including links, text posts, images, and videos.\"\"\"), # Better\n",
+    "    (\"\"\"League of Legends (LoL), commonly referred to as League, is a 2009 multiplayer online battle arena video game developed and published by Riot Games. \"\"\",\n",
+    "     \"\"\"When was League of Legends released?\"\"\",\n",
+    "     \"\"\"League of Legends was released in 2009.\"\"\",\n",
+    "     \"\"\"League of Legends was released in the early 2000s.\"\"\"), # Worse\n",
+    "    (\"\"\"Vitamin C (also known as ascorbic acid and ascorbate) is a water-soluble vitamin found in citrus and other fruits, berries and vegetables, also sold as a dietary supplement and as a topical serum ingredient to treat melasma (dark pigment spots) and wrinkles on the face.\"\"\",\n",
+    "     \"\"\"Is Vitamin C water-soluble?\"\"\",\n",
+    "     \"\"\"Yes, Vitamin C is a very water-soluble vitamin.\"\"\",\n",
+    "     \"\"\"Yes, Vitamin C can be dissolved in water well.\"\"\"), # Equally good\n",
     "]\n",
     "\n",
     "data = [\n",

example/rater/huggingface_classification.ipynb

@@ -165,7 +165,7 @@
    "source": [
     "config = RaterForClassificationHuggingfaceConfig(\n",
     "    model_config=HuggingfaceModelConfig(\n",
-    "        response_start_key=\"explanation\", \n",
+    "        response_start_key=\"explanation\",\n",
     "        response_format={\"type\": \"json_object\"},\n",
     "        batch_size=2\n",
     "    )\n",

example/transform/huggingface_model.ipynb

@@ -156,14 +156,14 @@
     "\n",
     "sample_examples = [\n",
     "        Context(\n",
-    "            context=\"The quick brown fox jumps over the lazy dog.\",\n",
-    "            question=\"What is the color of the fox?\",\n",
-    "            answer=\"brown.\"\n",
+    "            context=\"\"\"The quick brown fox jumps over the lazy dog.\"\"\",\n",
+    "            question=\"\"\"What is the color of the fox?\"\"\",\n",
+    "            answer=\"\"\"brown.\"\"\"\n",
     "        ),\n",
     "        Context(\n",
-    "            context=\"The quick brown fox jumps over the lazy black dog.\",\n",
-    "            question=\"What is the color of the dog?\",\n",
-    "            answer=\"black.\"\n",
+    "            context=\"\"\"The quick brown fox jumps over the lazy black dog.\"\"\",\n",
+    "            question=\"\"\"What is the color of the dog?\"\"\",\n",
+    "            answer=\"\"\"black.\"\"\"\n",
     "        )]\n",
     "\n",
     "guided_prompt = PromptTemplate(\n",

example/transform/huggingface_model_5QAs.ipynb

@@ -376,7 +376,6 @@
     }
    ],
    "source": [
-    "\n",
     "input_data = [\n",
     "    Context(context=data)\n",
     "    for data in raw_context_input_400\n",

example/transform/huggingface_model_neuron.ipynb

@@ -149,14 +149,14 @@
     "\n",
     "sample_examples = [\n",
     "        Context(\n",
-    "            context=\"The quick brown fox jumps over the lazy dog.\",\n",
-    "            question=\"What is the color of the fox?\",\n",
-    "            answer=\"brown.\"\n",
+    "            context=\"\"\"The quick brown fox jumps over the lazy dog.\"\"\",\n",
+    "            question=\"\"\"What is the color of the fox?\"\"\",\n",
+    "            answer=\"\"\"brown.\"\"\"\n",
     "        ),\n",
     "        Context(\n",
-    "            context=\"The quick brown fox jumps over the lazy black dog.\",\n",
-    "            question=\"What is the color of the dog?\",\n",
-    "            answer=\"black.\"\n",
+    "            context=\"\"\"The quick brown fox jumps over the lazy black dog.\"\"\",\n",
+    "            question=\"\"\"What is the color of the dog?\"\"\",\n",
+    "            answer=\"\"\"black.\"\"\"\n",
     "        )]\n",
     "\n",
     "guided_prompt = PromptTemplate(\n",
@@ -243,7 +243,6 @@
     }
    ],
    "source": [
-    "\n",
     "input_data = [\n",
     "    Context(context=data)\n",
     "    for data in raw_context_input_400\n",

example/transform/lmqg_model.ipynb

@@ -271,10 +271,10 @@
    "outputs": [],
    "source": [
     "raw_context_input = [\n",
-    "    \"\"\"William Turner was an English painter who specialised in watercolour landscapes. He is often known\n",
-    "          \"as William Turner of Oxford or just Turner of Oxford to distinguish him from his contemporary,\n",
-    "          \"J. M. W. Turner. Many of Turner's paintings depicted the countryside around Oxford. One of his\n",
-    "          \"best known pictures is a view of the city of Oxford from Hinksey Hill.\"\"\",\n",
+    "    \"\"\"William Turner was an English painter who specialised in watercolour landscapes. He is often known \\\n",
+    "as William Turner of Oxford or just Turner of Oxford to distinguish him from his contemporary, \\\n",
+    "J. M. W. Turner. Many of Turner's paintings depicted the countryside around Oxford. One of his \\\n",
+    "best known pictures is a view of the city of Oxford from Hinksey Hill.\"\"\",\n",
     "    \"\"\"My name is bobby and I am a talent software engineer working on AI/ML.\"\"\"\n",
     "]"
    ]

example/transform/model.ipynb

@@ -129,8 +129,8 @@
    "outputs": [],
    "source": [
     "raw_context_input = [\n",
-    "    \"It was a sunny day and the sky color is blue.\",\n",
-    "    \"My name is Bobby and I am a talent software engineer working on AI/ML\",\n",
+    "    \"\"\"It was a sunny day and the sky color is blue.\"\"\",\n",
+    "    \"\"\"My name is Bobby and I am a talent software engineer working on AI/ML\"\"\",\n",
     "]"
    ]
   },

example/transform/openai_json_model.ipynb

@@ -114,22 +114,22 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
     "guided_prompt = PromptTemplate(\n",
     "    instruction=\"Generate one question and its corresponding answer based on the context. Follow the format of the examples below to include context, question, and answer in the response in json\",\n",
     "    few_shot_prompt=[\n",
     "            Context(\n",
-    "                context=\"The quick brown fox jumps over the lazy black dog.\",\n",
-    "                question=\"What is the color of the fox?\",\n",
-    "                answer=\"brown.\",\n",
+    "                context=\"\"\"The quick brown fox jumps over the lazy black dog.\"\"\",\n",
+    "                question=\"\"\"What is the color of the fox?\"\"\",\n",
+    "                answer=\"\"\"brown.\"\"\"\n",
     "            ),\n",
     "            Context(\n",
-    "                context=\"The quick brown fox jumps over the lazy black dog.\",\n",
-    "                question=\"What is the color of the dog?\",\n",
-    "                answer=\"black.\",\n",
+    "                context=\"\"\"The quick brown fox jumps over the lazy black dog.\"\"\",\n",
+    "                question=\"\"\"What is the color of the dog?\"\"\",\n",
+    "                answer=\"\"\"black.\"\"\"\n",
     "            ),\n",
     "        ],\n",
     ")"
@@ -149,8 +149,8 @@
    "outputs": [],
    "source": [
     "raw_context_input = [\n",
-    "    \"It was a sunny day and the sky color is blue.\",\n",
-    "    \"My name is bobby and I am a talent software engineer working on AI/ML.\",\n",
+    "    \"\"\"It was a sunny day and the sky color is blue.\"\"\",\n",
+    "    \"\"\"My name is bobby and I am a talent software engineer working on AI/ML.\"\"\"\n",
     "]"
    ]
   },