kiln-ai 0.11.1__tar.gz → 0.13.0__tar.gz

kiln_ai-0.13.0/.python-version

@@ -0,0 +1 @@
+3.13

{kiln_ai-0.11.1 → kiln_ai-0.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kiln-ai
-Version: 0.11.1
+Version: 0.13.0
 Summary: Kiln AI
 Project-URL: Homepage, https://getkiln.ai
 Project-URL: Repository, https://github.com/Kiln-AI/kiln
@@ -13,20 +13,20 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.10
+Requires-Dist: boto3>=1.37.10
 Requires-Dist: coverage>=7.6.4
+Requires-Dist: google-cloud-aiplatform>=1.84.0
 Requires-Dist: jsonschema>=4.23.0
-Requires-Dist: langchain-aws>=0.2.4
-Requires-Dist: langchain-fireworks>=0.2.5
-Requires-Dist: langchain-groq>=0.2.0
-Requires-Dist: langchain-ollama>=0.2.2
-Requires-Dist: langchain>=0.3.5
+Requires-Dist: litellm>=1.63.5
 Requires-Dist: openai>=1.53.0
 Requires-Dist: pdoc>=15.0.0
 Requires-Dist: pydantic>=2.9.2
 Requires-Dist: pytest-benchmark>=5.1.0
 Requires-Dist: pytest-cov>=6.0.0
 Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: together>=1.4.6
 Requires-Dist: typing-extensions>=4.12.2
 Description-Content-Type: text/markdown
 
@@ -71,6 +71,8 @@ The library has a [comprehensive set of docs](https://kiln-ai.github.io/Kiln/kil
   - [Load an Existing Dataset into a Kiln Task Dataset](#load-an-existing-dataset-into-a-kiln-task-dataset)
   - [Using your Kiln Dataset in a Notebook or Project](#using-your-kiln-dataset-in-a-notebook-or-project)
   - [Using Kiln Dataset in Pandas](#using-kiln-dataset-in-pandas)
+  - [Building and Running a Kiln Task from Code](#building-and-running-a-kiln-task-from-code)
+  - [Adding Custom Model or AI Provider from Code](#adding-custom-model-or-ai-provider-from-code)
 - [Full API Reference](#full-api-reference)
 
 ## Installation
@@ -232,6 +234,84 @@ final_df = pd.concat(dfs, ignore_index=True)
 print(final_df)
 ```
 
+### Building and Running a Kiln Task from Code
+
+```python
+# Step 1: Create or Load a Task -- choose one of the following 1.A or 1.B
+
+# Step 1.A: Optionally load an existing task from disk
+# task = datamodel.Task.load_from_file("path/to/task.kiln")
+
+# Step 1.B: Create a new task in code, without saving to disk.
+task = datamodel.Task(
+    name="test task",
+    instruction="Tell a joke, given a subject.",
+)
+# replace with a valid JSON schema https://json-schema.org for your task (json string, not a python dict).
+# Or delete this line to use plaintext output
+task.output_json_schema = json_joke_schema
+
+# Step 2: Create an Adapter to run the task, with a specific model and provider
+adapter = adapter_for_task(task, model_name="llama_3_1_8b", provider="groq")
+
+# Step 3: Invoke the Adapter to run the task
+task_input = "cows"
+response = await adapter.invoke(task_input)
+print(f"Output: {response.output.output}")
+
+# Step 4 (optional): Load the task from disk and print the results.
+#  This will only work if the task was loaded from disk, or you called task.save_to_file() before invoking the adapter (ephemeral tasks don't save their result to disk)
+task = datamodel.Task.load_from_file(tmp_path / "test_task.kiln")
+for run in task.runs():
+    print(f"Run: {run.id}")
+    print(f"Input: {run.input}")
+    print(f"Output: {run.output}")
+
+```
+
+### Adding Custom Model or AI Provider from Code
+
+You can add additional AI models and providers to Kiln.
+
+See our docs for more information, including how to add these from the UI:
+
+- [Custom Models From Existing Providers](https://docs.getkiln.ai/docs/models-and-ai-providers#custom-models-from-existing-providers)
+- [Custom OpenAI Compatible Servers](https://docs.getkiln.ai/docs/models-and-ai-providers#custom-openai-compatible-servers)
+
+You can also add these from code. The kiln_ai.utils.Config class helps you manage the Kiln config file (stored at `~/.kiln_settings/config.yaml`):
+
+```python
+# Addding an OpenAI compatible provider
+name = "CustomOllama"
+base_url = "http://localhost:1234/api/v1"
+api_key = "12345"
+providers = Config.shared().openai_compatible_providers or []
+existing_provider = next((p for p in providers if p["name"] == name), None)
+if existing_provider:
+    # skip since this already exists
+    return
+providers.append(
+    {
+        "name": name,
+        "base_url": base_url,
+        "api_key": api_key,
+    }
+)
+Config.shared().openai_compatible_providers = providers
+```
+
+```python
+# Add a custom model ID to an existing provider.
+new_model = "openai::gpt-3.5-turbo"
+custom_model_ids = Config.shared().custom_models
+existing_model = next((m for m in custom_model_ids if m == new_model), None)
+if existing_model:
+    # skip since this already exists
+    return
+custom_model_ids.append(new_model)
+Config.shared().custom_models = custom_model_ids
+```
+
 ## Full API Reference
 
 The library can do a lot more than the examples we've shown here.

{kiln_ai-0.11.1 → kiln_ai-0.13.0}/README.md

@@ -39,6 +39,8 @@ The library has a [comprehensive set of docs](https://kiln-ai.github.io/Kiln/kil
   - [Load an Existing Dataset into a Kiln Task Dataset](#load-an-existing-dataset-into-a-kiln-task-dataset)
   - [Using your Kiln Dataset in a Notebook or Project](#using-your-kiln-dataset-in-a-notebook-or-project)
   - [Using Kiln Dataset in Pandas](#using-kiln-dataset-in-pandas)
+  - [Building and Running a Kiln Task from Code](#building-and-running-a-kiln-task-from-code)
+  - [Adding Custom Model or AI Provider from Code](#adding-custom-model-or-ai-provider-from-code)
 - [Full API Reference](#full-api-reference)
 
 ## Installation
@@ -200,6 +202,84 @@ final_df = pd.concat(dfs, ignore_index=True)
 print(final_df)
 ```
 
+### Building and Running a Kiln Task from Code
+
+```python
+# Step 1: Create or Load a Task -- choose one of the following 1.A or 1.B
+
+# Step 1.A: Optionally load an existing task from disk
+# task = datamodel.Task.load_from_file("path/to/task.kiln")
+
+# Step 1.B: Create a new task in code, without saving to disk.
+task = datamodel.Task(
+    name="test task",
+    instruction="Tell a joke, given a subject.",
+)
+# replace with a valid JSON schema https://json-schema.org for your task (json string, not a python dict).
+# Or delete this line to use plaintext output
+task.output_json_schema = json_joke_schema
+
+# Step 2: Create an Adapter to run the task, with a specific model and provider
+adapter = adapter_for_task(task, model_name="llama_3_1_8b", provider="groq")
+
+# Step 3: Invoke the Adapter to run the task
+task_input = "cows"
+response = await adapter.invoke(task_input)
+print(f"Output: {response.output.output}")
+
+# Step 4 (optional): Load the task from disk and print the results.
+#  This will only work if the task was loaded from disk, or you called task.save_to_file() before invoking the adapter (ephemeral tasks don't save their result to disk)
+task = datamodel.Task.load_from_file(tmp_path / "test_task.kiln")
+for run in task.runs():
+    print(f"Run: {run.id}")
+    print(f"Input: {run.input}")
+    print(f"Output: {run.output}")
+
+```
+
+### Adding Custom Model or AI Provider from Code
+
+You can add additional AI models and providers to Kiln.
+
+See our docs for more information, including how to add these from the UI:
+
+- [Custom Models From Existing Providers](https://docs.getkiln.ai/docs/models-and-ai-providers#custom-models-from-existing-providers)
+- [Custom OpenAI Compatible Servers](https://docs.getkiln.ai/docs/models-and-ai-providers#custom-openai-compatible-servers)
+
+You can also add these from code. The kiln_ai.utils.Config class helps you manage the Kiln config file (stored at `~/.kiln_settings/config.yaml`):
+
+```python
+# Addding an OpenAI compatible provider
+name = "CustomOllama"
+base_url = "http://localhost:1234/api/v1"
+api_key = "12345"
+providers = Config.shared().openai_compatible_providers or []
+existing_provider = next((p for p in providers if p["name"] == name), None)
+if existing_provider:
+    # skip since this already exists
+    return
+providers.append(
+    {
+        "name": name,
+        "base_url": base_url,
+        "api_key": api_key,
+    }
+)
+Config.shared().openai_compatible_providers = providers
+```
+
+```python
+# Add a custom model ID to an existing provider.
+new_model = "openai::gpt-3.5-turbo"
+custom_model_ids = Config.shared().custom_models
+existing_model = next((m for m in custom_model_ids if m == new_model), None)
+if existing_model:
+    # skip since this already exists
+    return
+custom_model_ids.append(new_model)
+Config.shared().custom_models = custom_model_ids
+```
+
 ## Full API Reference
 
 The library can do a lot more than the examples we've shown here.

{kiln_ai-0.11.1 → kiln_ai-0.13.0}/docs/kiln_core_docs/kiln_ai/adapters/data_gen/data_gen_task.html

@@ -127,6 +127,9 @@
                 </ul>
 
             </li>
+            <li>
+                    <a class="function" href="#wrap_task_with_guidance">wrap_task_with_guidance</a>
+            </li>
     </ul>
 
 
@@ -205,7 +208,7 @@
 </span><span id="L-55"><a href="#L-55"><span class="linenos"> 55</span></a>            <span class="n">num_subtopics</span><span class="o">=</span><span class="n">num_subtopics</span><span class="p">,</span>
 </span><span id="L-56"><a href="#L-56"><span class="linenos"> 56</span></a>            <span class="n">human_guidance</span><span class="o">=</span><span class="n">human_guidance</span><span class="p">,</span>
 </span><span id="L-57"><a href="#L-57"><span class="linenos"> 57</span></a>            <span class="n">existing_topics</span><span class="o">=</span><span class="n">existing_topics</span><span class="p">,</span>
-</span><span id="L-58"><a href="#L-58"><span class="linenos"> 58</span></a>            <span class="n">system_prompt</span><span class="o">=</span><span class="n">prompt_builder</span><span class="o">.</span><span class="n">build_prompt</span><span class="p">(),</span>
+</span><span id="L-58"><a href="#L-58"><span class="linenos"> 58</span></a>            <span class="n">system_prompt</span><span class="o">=</span><span class="n">prompt_builder</span><span class="o">.</span><span class="n">build_prompt</span><span class="p">(</span><span class="n">include_json_instructions</span><span class="o">=</span><span class="kc">False</span><span class="p">),</span>
 </span><span id="L-59"><a href="#L-59"><span class="linenos"> 59</span></a>        <span class="p">)</span>
 </span><span id="L-60"><a href="#L-60"><span class="linenos"> 60</span></a>
 </span><span id="L-61"><a href="#L-61"><span class="linenos"> 61</span></a>
@@ -282,7 +285,7 @@
 </span><span id="L-132"><a href="#L-132"><span class="linenos">132</span></a>            <span class="n">topic</span><span class="o">=</span><span class="n">topic</span><span class="p">,</span>
 </span><span id="L-133"><a href="#L-133"><span class="linenos">133</span></a>            <span class="n">num_samples</span><span class="o">=</span><span class="n">num_samples</span><span class="p">,</span>
 </span><span id="L-134"><a href="#L-134"><span class="linenos">134</span></a>            <span class="n">human_guidance</span><span class="o">=</span><span class="n">human_guidance</span><span class="p">,</span>
-</span><span id="L-135"><a href="#L-135"><span class="linenos">135</span></a>            <span class="n">system_prompt</span><span class="o">=</span><span class="n">prompt_builder</span><span class="o">.</span><span class="n">build_prompt</span><span class="p">(),</span>
+</span><span id="L-135"><a href="#L-135"><span class="linenos">135</span></a>            <span class="n">system_prompt</span><span class="o">=</span><span class="n">prompt_builder</span><span class="o">.</span><span class="n">build_prompt</span><span class="p">(</span><span class="n">include_json_instructions</span><span class="o">=</span><span class="kc">False</span><span class="p">),</span>
 </span><span id="L-136"><a href="#L-136"><span class="linenos">136</span></a>        <span class="p">)</span>
 </span><span id="L-137"><a href="#L-137"><span class="linenos">137</span></a>
 </span><span id="L-138"><a href="#L-138"><span class="linenos">138</span></a>
@@ -333,6 +336,24 @@
 </span><span id="L-183"><a href="#L-183"><span class="linenos">183</span></a>            <span class="n">input_json_schema</span><span class="o">=</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">DataGenSampleTaskInput</span><span class="o">.</span><span class="n">model_json_schema</span><span class="p">()),</span>
 </span><span id="L-184"><a href="#L-184"><span class="linenos">184</span></a>            <span class="n">output_json_schema</span><span class="o">=</span><span class="n">list_json_schema_for_task</span><span class="p">(</span><span class="n">target_task</span><span class="p">),</span>
 </span><span id="L-185"><a href="#L-185"><span class="linenos">185</span></a>        <span class="p">)</span>
+</span><span id="L-186"><a href="#L-186"><span class="linenos">186</span></a>
+</span><span id="L-187"><a href="#L-187"><span class="linenos">187</span></a>
+</span><span id="L-188"><a href="#L-188"><span class="linenos">188</span></a><span class="k">def</span> <span class="nf">wrap_task_with_guidance</span><span class="p">(</span><span class="n">original_instruction</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">guidance</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
+</span><span id="L-189"><a href="#L-189"><span class="linenos">189</span></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;Wrap the original instruction with human guidance.</span>
+</span><span id="L-190"><a href="#L-190"><span class="linenos">190</span></a>
+</span><span id="L-191"><a href="#L-191"><span class="linenos">191</span></a><span class="sd">    Args:</span>
+</span><span id="L-192"><a href="#L-192"><span class="linenos">192</span></a><span class="sd">        original_instruction: The original instruction to wrap</span>
+</span><span id="L-193"><a href="#L-193"><span class="linenos">193</span></a><span class="sd">        guidance: The human guidance to wrap the instruction with</span>
+</span><span id="L-194"><a href="#L-194"><span class="linenos">194</span></a><span class="sd">    &quot;&quot;&quot;</span>
+</span><span id="L-195"><a href="#L-195"><span class="linenos">195</span></a>    <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;&quot;&quot;</span><span class="si">{</span><span class="n">original_instruction</span><span class="si">}</span>
+</span><span id="L-196"><a href="#L-196"><span class="linenos">196</span></a>
+</span><span id="L-197"><a href="#L-197"><span class="linenos">197</span></a><span class="s2"># Special Instructions</span>
+</span><span id="L-198"><a href="#L-198"><span class="linenos">198</span></a>
+</span><span id="L-199"><a href="#L-199"><span class="linenos">199</span></a><span class="s2">The above instructions are the original instructions for this task. For this execution, we&#39;ve been given additional instructions. Follow both, but prioritize the additional instructions when they conflict. The additional instructions are:</span>
+</span><span id="L-200"><a href="#L-200"><span class="linenos">200</span></a><span class="s2">&lt;additional_instructions&gt;</span>
+</span><span id="L-201"><a href="#L-201"><span class="linenos">201</span></a><span class="si">{</span><span class="n">guidance</span><span class="si">}</span>
+</span><span id="L-202"><a href="#L-202"><span class="linenos">202</span></a><span class="s2">&lt;/additional_instructions&gt;</span>
+</span><span id="L-203"><a href="#L-203"><span class="linenos">203</span></a><span class="s2">&quot;&quot;&quot;</span>
 </span></pre></div>
 
 
@@ -392,7 +413,7 @@
 </span><span id="DataGenCategoriesTaskInput-56"><a href="#DataGenCategoriesTaskInput-56"><span class="linenos">56</span></a>            <span class="n">num_subtopics</span><span class="o">=</span><span class="n">num_subtopics</span><span class="p">,</span>
 </span><span id="DataGenCategoriesTaskInput-57"><a href="#DataGenCategoriesTaskInput-57"><span class="linenos">57</span></a>            <span class="n">human_guidance</span><span class="o">=</span><span class="n">human_guidance</span><span class="p">,</span>
 </span><span id="DataGenCategoriesTaskInput-58"><a href="#DataGenCategoriesTaskInput-58"><span class="linenos">58</span></a>            <span class="n">existing_topics</span><span class="o">=</span><span class="n">existing_topics</span><span class="p">,</span>
-</span><span id="DataGenCategoriesTaskInput-59"><a href="#DataGenCategoriesTaskInput-59"><span class="linenos">59</span></a>            <span class="n">system_prompt</span><span class="o">=</span><span class="n">prompt_builder</span><span class="o">.</span><span class="n">build_prompt</span><span class="p">(),</span>
+</span><span id="DataGenCategoriesTaskInput-59"><a href="#DataGenCategoriesTaskInput-59"><span class="linenos">59</span></a>            <span class="n">system_prompt</span><span class="o">=</span><span class="n">prompt_builder</span><span class="o">.</span><span class="n">build_prompt</span><span class="p">(</span><span class="n">include_json_instructions</span><span class="o">=</span><span class="kc">False</span><span class="p">),</span>
 </span><span id="DataGenCategoriesTaskInput-60"><a href="#DataGenCategoriesTaskInput-60"><span class="linenos">60</span></a>        <span class="p">)</span>
 </span></pre></div>
 
@@ -502,7 +523,7 @@
 </span><span id="DataGenCategoriesTaskInput.from_task-56"><a href="#DataGenCategoriesTaskInput.from_task-56"><span class="linenos">56</span></a>            <span class="n">num_subtopics</span><span class="o">=</span><span class="n">num_subtopics</span><span class="p">,</span>
 </span><span id="DataGenCategoriesTaskInput.from_task-57"><a href="#DataGenCategoriesTaskInput.from_task-57"><span class="linenos">57</span></a>            <span class="n">human_guidance</span><span class="o">=</span><span class="n">human_guidance</span><span class="p">,</span>
 </span><span id="DataGenCategoriesTaskInput.from_task-58"><a href="#DataGenCategoriesTaskInput.from_task-58"><span class="linenos">58</span></a>            <span class="n">existing_topics</span><span class="o">=</span><span class="n">existing_topics</span><span class="p">,</span>
-</span><span id="DataGenCategoriesTaskInput.from_task-59"><a href="#DataGenCategoriesTaskInput.from_task-59"><span class="linenos">59</span></a>            <span class="n">system_prompt</span><span class="o">=</span><span class="n">prompt_builder</span><span class="o">.</span><span class="n">build_prompt</span><span class="p">(),</span>
+</span><span id="DataGenCategoriesTaskInput.from_task-59"><a href="#DataGenCategoriesTaskInput.from_task-59"><span class="linenos">59</span></a>            <span class="n">system_prompt</span><span class="o">=</span><span class="n">prompt_builder</span><span class="o">.</span><span class="n">build_prompt</span><span class="p">(</span><span class="n">include_json_instructions</span><span class="o">=</span><span class="kc">False</span><span class="p">),</span>
 </span><span id="DataGenCategoriesTaskInput.from_task-60"><a href="#DataGenCategoriesTaskInput.from_task-60"><span class="linenos">60</span></a>        <span class="p">)</span>
 </span></pre></div>
 
@@ -597,7 +618,7 @@
 <div class="attr class">
             
     <span class="def">class</span>
-    <span class="name">DataGenCategoriesTask</span><wbr>(<span class="base"><a href="../../datamodel.html#Task">kiln_ai.datamodel.Task</a></span>):
+    <span class="name">DataGenCategoriesTask</span><wbr>(<span class="base">kiln_ai.datamodel.task.Task</span>):
 
                 <label class="view-source-button" for="DataGenCategoriesTask-view-source"><span>View Source</span></label>
 
@@ -713,63 +734,6 @@ method.</p>
 
 
                             </div>
-                            <div class="inherited">
-                                <h5>Inherited Members</h5>
-                                <dl>
-                                    <div><dt><a href="../../datamodel.html#Task">kiln_ai.datamodel.Task</a></dt>
-                                <dd id="DataGenCategoriesTask.name" class="variable"><a href="../../datamodel.html#Task.name">name</a></dd>
-                <dd id="DataGenCategoriesTask.description" class="variable"><a href="../../datamodel.html#Task.description">description</a></dd>
-                <dd id="DataGenCategoriesTask.instruction" class="variable"><a href="../../datamodel.html#Task.instruction">instruction</a></dd>
-                <dd id="DataGenCategoriesTask.requirements" class="variable"><a href="../../datamodel.html#Task.requirements">requirements</a></dd>
-                <dd id="DataGenCategoriesTask.output_json_schema" class="variable"><a href="../../datamodel.html#Task.output_json_schema">output_json_schema</a></dd>
-                <dd id="DataGenCategoriesTask.input_json_schema" class="variable"><a href="../../datamodel.html#Task.input_json_schema">input_json_schema</a></dd>
-                <dd id="DataGenCategoriesTask.thinking_instruction" class="variable"><a href="../../datamodel.html#Task.thinking_instruction">thinking_instruction</a></dd>
-                <dd id="DataGenCategoriesTask.output_schema" class="function"><a href="../../datamodel.html#Task.output_schema">output_schema</a></dd>
-                <dd id="DataGenCategoriesTask.input_schema" class="function"><a href="../../datamodel.html#Task.input_schema">input_schema</a></dd>
-                <dd id="DataGenCategoriesTask.runs" class="function"><a href="../../datamodel.html#Task.runs">runs</a></dd>
-                <dd id="DataGenCategoriesTask.dataset_splits" class="function"><a href="../../datamodel.html#Task.dataset_splits">dataset_splits</a></dd>
-                <dd id="DataGenCategoriesTask.finetunes" class="function"><a href="../../datamodel.html#Task.finetunes">finetunes</a></dd>
-                <dd id="DataGenCategoriesTask.prompts" class="function"><a href="../../datamodel.html#Task.prompts">prompts</a></dd>
-                <dd id="DataGenCategoriesTask.relationship_name" class="function"><a href="../../datamodel.html#Task.relationship_name">relationship_name</a></dd>
-                <dd id="DataGenCategoriesTask.parent_type" class="function"><a href="../../datamodel.html#Task.parent_type">parent_type</a></dd>
-
-            </div>
-            <div><dt><a href="../../datamodel/basemodel.html#KilnParentedModel">kiln_ai.datamodel.basemodel.KilnParentedModel</a></dt>
-                                <dd id="DataGenCategoriesTask.parent" class="variable"><a href="../../datamodel/basemodel.html#KilnParentedModel.parent">parent</a></dd>
-                <dd id="DataGenCategoriesTask.cached_parent" class="function"><a href="../../datamodel/basemodel.html#KilnParentedModel.cached_parent">cached_parent</a></dd>
-                <dd id="DataGenCategoriesTask.load_parent" class="function"><a href="../../datamodel/basemodel.html#KilnParentedModel.load_parent">load_parent</a></dd>
-                <dd id="DataGenCategoriesTask.check_parent_type" class="function"><a href="../../datamodel/basemodel.html#KilnParentedModel.check_parent_type">check_parent_type</a></dd>
-                <dd id="DataGenCategoriesTask.build_child_dirname" class="function"><a href="../../datamodel/basemodel.html#KilnParentedModel.build_child_dirname">build_child_dirname</a></dd>
-                <dd id="DataGenCategoriesTask.build_path" class="function"><a href="../../datamodel/basemodel.html#KilnParentedModel.build_path">build_path</a></dd>
-                <dd id="DataGenCategoriesTask.iterate_children_paths_of_parent_path" class="function"><a href="../../datamodel/basemodel.html#KilnParentedModel.iterate_children_paths_of_parent_path">iterate_children_paths_of_parent_path</a></dd>
-                <dd id="DataGenCategoriesTask.all_children_of_parent_path" class="function"><a href="../../datamodel/basemodel.html#KilnParentedModel.all_children_of_parent_path">all_children_of_parent_path</a></dd>
-                <dd id="DataGenCategoriesTask.from_id_and_parent_path" class="function"><a href="../../datamodel/basemodel.html#KilnParentedModel.from_id_and_parent_path">from_id_and_parent_path</a></dd>
-
-            </div>
-            <div><dt><a href="../../datamodel/basemodel.html#KilnParentModel">kiln_ai.datamodel.basemodel.KilnParentModel</a></dt>
-                                <dd id="DataGenCategoriesTask.validate_and_save_with_subrelations" class="function"><a href="../../datamodel/basemodel.html#KilnParentModel.validate_and_save_with_subrelations">validate_and_save_with_subrelations</a></dd>
-
-            </div>
-            <div><dt><a href="../../datamodel/basemodel.html#KilnBaseModel">kiln_ai.datamodel.basemodel.KilnBaseModel</a></dt>
-                                <dd id="DataGenCategoriesTask.v" class="variable"><a href="../../datamodel/basemodel.html#KilnBaseModel.v">v</a></dd>
-                <dd id="DataGenCategoriesTask.id" class="variable"><a href="../../datamodel/basemodel.html#KilnBaseModel.id">id</a></dd>
-                <dd id="DataGenCategoriesTask.path" class="variable"><a href="../../datamodel/basemodel.html#KilnBaseModel.path">path</a></dd>
-                <dd id="DataGenCategoriesTask.created_at" class="variable"><a href="../../datamodel/basemodel.html#KilnBaseModel.created_at">created_at</a></dd>
-                <dd id="DataGenCategoriesTask.created_by" class="variable"><a href="../../datamodel/basemodel.html#KilnBaseModel.created_by">created_by</a></dd>
-                <dd id="DataGenCategoriesTask.model_type" class="variable"><a href="../../datamodel/basemodel.html#KilnBaseModel.model_type">model_type</a></dd>
-                <dd id="DataGenCategoriesTask.type_name" class="function"><a href="../../datamodel/basemodel.html#KilnBaseModel.type_name">type_name</a></dd>
-                <dd id="DataGenCategoriesTask.base_filename" class="function"><a href="../../datamodel/basemodel.html#KilnBaseModel.base_filename">base_filename</a></dd>
-                <dd id="DataGenCategoriesTask.load_from_folder" class="function"><a href="../../datamodel/basemodel.html#KilnBaseModel.load_from_folder">load_from_folder</a></dd>
-                <dd id="DataGenCategoriesTask.load_from_file" class="function"><a href="../../datamodel/basemodel.html#KilnBaseModel.load_from_file">load_from_file</a></dd>
-                <dd id="DataGenCategoriesTask.loaded_from_file" class="function"><a href="../../datamodel/basemodel.html#KilnBaseModel.loaded_from_file">loaded_from_file</a></dd>
-                <dd id="DataGenCategoriesTask.loading_from_file" class="function"><a href="../../datamodel/basemodel.html#KilnBaseModel.loading_from_file">loading_from_file</a></dd>
-                <dd id="DataGenCategoriesTask.save_to_file" class="function"><a href="../../datamodel/basemodel.html#KilnBaseModel.save_to_file">save_to_file</a></dd>
-                <dd id="DataGenCategoriesTask.delete" class="function"><a href="../../datamodel/basemodel.html#KilnBaseModel.delete">delete</a></dd>
-                <dd id="DataGenCategoriesTask.max_schema_version" class="function"><a href="../../datamodel/basemodel.html#KilnBaseModel.max_schema_version">max_schema_version</a></dd>
-
-            </div>
-                                </dl>
-                            </div>
                 </section>
                 <section id="DataGenSampleTaskInput">
                             <input id="DataGenSampleTaskInput-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
@@ -821,7 +785,7 @@ method.</p>
 </span><span id="DataGenSampleTaskInput-133"><a href="#DataGenSampleTaskInput-133"><span class="linenos">133</span></a>            <span class="n">topic</span><span class="o">=</span><span class="n">topic</span><span class="p">,</span>
 </span><span id="DataGenSampleTaskInput-134"><a href="#DataGenSampleTaskInput-134"><span class="linenos">134</span></a>            <span class="n">num_samples</span><span class="o">=</span><span class="n">num_samples</span><span class="p">,</span>
 </span><span id="DataGenSampleTaskInput-135"><a href="#DataGenSampleTaskInput-135"><span class="linenos">135</span></a>            <span class="n">human_guidance</span><span class="o">=</span><span class="n">human_guidance</span><span class="p">,</span>
-</span><span id="DataGenSampleTaskInput-136"><a href="#DataGenSampleTaskInput-136"><span class="linenos">136</span></a>            <span class="n">system_prompt</span><span class="o">=</span><span class="n">prompt_builder</span><span class="o">.</span><span class="n">build_prompt</span><span class="p">(),</span>
+</span><span id="DataGenSampleTaskInput-136"><a href="#DataGenSampleTaskInput-136"><span class="linenos">136</span></a>            <span class="n">system_prompt</span><span class="o">=</span><span class="n">prompt_builder</span><span class="o">.</span><span class="n">build_prompt</span><span class="p">(</span><span class="n">include_json_instructions</span><span class="o">=</span><span class="kc">False</span><span class="p">),</span>
 </span><span id="DataGenSampleTaskInput-137"><a href="#DataGenSampleTaskInput-137"><span class="linenos">137</span></a>        <span class="p">)</span>
 </span></pre></div>
 
@@ -916,7 +880,7 @@ method.</p>
 </span><span id="DataGenSampleTaskInput.from_task-133"><a href="#DataGenSampleTaskInput.from_task-133"><span class="linenos">133</span></a>            <span class="n">topic</span><span class="o">=</span><span class="n">topic</span><span class="p">,</span>
 </span><span id="DataGenSampleTaskInput.from_task-134"><a href="#DataGenSampleTaskInput.from_task-134"><span class="linenos">134</span></a>            <span class="n">num_samples</span><span class="o">=</span><span class="n">num_samples</span><span class="p">,</span>
 </span><span id="DataGenSampleTaskInput.from_task-135"><a href="#DataGenSampleTaskInput.from_task-135"><span class="linenos">135</span></a>            <span class="n">human_guidance</span><span class="o">=</span><span class="n">human_guidance</span><span class="p">,</span>
-</span><span id="DataGenSampleTaskInput.from_task-136"><a href="#DataGenSampleTaskInput.from_task-136"><span class="linenos">136</span></a>            <span class="n">system_prompt</span><span class="o">=</span><span class="n">prompt_builder</span><span class="o">.</span><span class="n">build_prompt</span><span class="p">(),</span>
+</span><span id="DataGenSampleTaskInput.from_task-136"><a href="#DataGenSampleTaskInput.from_task-136"><span class="linenos">136</span></a>            <span class="n">system_prompt</span><span class="o">=</span><span class="n">prompt_builder</span><span class="o">.</span><span class="n">build_prompt</span><span class="p">(</span><span class="n">include_json_instructions</span><span class="o">=</span><span class="kc">False</span><span class="p">),</span>
 </span><span id="DataGenSampleTaskInput.from_task-137"><a href="#DataGenSampleTaskInput.from_task-137"><span class="linenos">137</span></a>        <span class="p">)</span>
 </span></pre></div>
 
@@ -1008,7 +972,7 @@ method.</p>
 <div class="attr class">
             
     <span class="def">class</span>
-    <span class="name">DataGenSampleTask</span><wbr>(<span class="base"><a href="../../datamodel.html#Task">kiln_ai.datamodel.Task</a></span>):
+    <span class="name">DataGenSampleTask</span><wbr>(<span class="base">kiln_ai.datamodel.task.Task</span>):
 
                 <label class="view-source-button" for="DataGenSampleTask-view-source"><span>View Source</span></label>
 
@@ -1114,63 +1078,45 @@ method.</p>
 
 
                             </div>
-                            <div class="inherited">
-                                <h5>Inherited Members</h5>
-                                <dl>
-                                    <div><dt><a href="../../datamodel.html#Task">kiln_ai.datamodel.Task</a></dt>
-                                <dd id="DataGenSampleTask.name" class="variable"><a href="../../datamodel.html#Task.name">name</a></dd>
-                <dd id="DataGenSampleTask.description" class="variable"><a href="../../datamodel.html#Task.description">description</a></dd>
-                <dd id="DataGenSampleTask.instruction" class="variable"><a href="../../datamodel.html#Task.instruction">instruction</a></dd>
-                <dd id="DataGenSampleTask.requirements" class="variable"><a href="../../datamodel.html#Task.requirements">requirements</a></dd>
-                <dd id="DataGenSampleTask.output_json_schema" class="variable"><a href="../../datamodel.html#Task.output_json_schema">output_json_schema</a></dd>
-                <dd id="DataGenSampleTask.input_json_schema" class="variable"><a href="../../datamodel.html#Task.input_json_schema">input_json_schema</a></dd>
-                <dd id="DataGenSampleTask.thinking_instruction" class="variable"><a href="../../datamodel.html#Task.thinking_instruction">thinking_instruction</a></dd>
-                <dd id="DataGenSampleTask.output_schema" class="function"><a href="../../datamodel.html#Task.output_schema">output_schema</a></dd>
-                <dd id="DataGenSampleTask.input_schema" class="function"><a href="../../datamodel.html#Task.input_schema">input_schema</a></dd>
-                <dd id="DataGenSampleTask.runs" class="function"><a href="../../datamodel.html#Task.runs">runs</a></dd>
-                <dd id="DataGenSampleTask.dataset_splits" class="function"><a href="../../datamodel.html#Task.dataset_splits">dataset_splits</a></dd>
-                <dd id="DataGenSampleTask.finetunes" class="function"><a href="../../datamodel.html#Task.finetunes">finetunes</a></dd>
-                <dd id="DataGenSampleTask.prompts" class="function"><a href="../../datamodel.html#Task.prompts">prompts</a></dd>
-                <dd id="DataGenSampleTask.relationship_name" class="function"><a href="../../datamodel.html#Task.relationship_name">relationship_name</a></dd>
-                <dd id="DataGenSampleTask.parent_type" class="function"><a href="../../datamodel.html#Task.parent_type">parent_type</a></dd>
-
-            </div>
-            <div><dt><a href="../../datamodel/basemodel.html#KilnParentedModel">kiln_ai.datamodel.basemodel.KilnParentedModel</a></dt>
-                                <dd id="DataGenSampleTask.parent" class="variable"><a href="../../datamodel/basemodel.html#KilnParentedModel.parent">parent</a></dd>
-                <dd id="DataGenSampleTask.cached_parent" class="function"><a href="../../datamodel/basemodel.html#KilnParentedModel.cached_parent">cached_parent</a></dd>
-                <dd id="DataGenSampleTask.load_parent" class="function"><a href="../../datamodel/basemodel.html#KilnParentedModel.load_parent">load_parent</a></dd>
-                <dd id="DataGenSampleTask.check_parent_type" class="function"><a href="../../datamodel/basemodel.html#KilnParentedModel.check_parent_type">check_parent_type</a></dd>
-                <dd id="DataGenSampleTask.build_child_dirname" class="function"><a href="../../datamodel/basemodel.html#KilnParentedModel.build_child_dirname">build_child_dirname</a></dd>
-                <dd id="DataGenSampleTask.build_path" class="function"><a href="../../datamodel/basemodel.html#KilnParentedModel.build_path">build_path</a></dd>
-                <dd id="DataGenSampleTask.iterate_children_paths_of_parent_path" class="function"><a href="../../datamodel/basemodel.html#KilnParentedModel.iterate_children_paths_of_parent_path">iterate_children_paths_of_parent_path</a></dd>
-                <dd id="DataGenSampleTask.all_children_of_parent_path" class="function"><a href="../../datamodel/basemodel.html#KilnParentedModel.all_children_of_parent_path">all_children_of_parent_path</a></dd>
-                <dd id="DataGenSampleTask.from_id_and_parent_path" class="function"><a href="../../datamodel/basemodel.html#KilnParentedModel.from_id_and_parent_path">from_id_and_parent_path</a></dd>
-
-            </div>
-            <div><dt><a href="../../datamodel/basemodel.html#KilnParentModel">kiln_ai.datamodel.basemodel.KilnParentModel</a></dt>
-                                <dd id="DataGenSampleTask.validate_and_save_with_subrelations" class="function"><a href="../../datamodel/basemodel.html#KilnParentModel.validate_and_save_with_subrelations">validate_and_save_with_subrelations</a></dd>
-
-            </div>
-            <div><dt><a href="../../datamodel/basemodel.html#KilnBaseModel">kiln_ai.datamodel.basemodel.KilnBaseModel</a></dt>
-                                <dd id="DataGenSampleTask.v" class="variable"><a href="../../datamodel/basemodel.html#KilnBaseModel.v">v</a></dd>
-                <dd id="DataGenSampleTask.id" class="variable"><a href="../../datamodel/basemodel.html#KilnBaseModel.id">id</a></dd>
-                <dd id="DataGenSampleTask.path" class="variable"><a href="../../datamodel/basemodel.html#KilnBaseModel.path">path</a></dd>
-                <dd id="DataGenSampleTask.created_at" class="variable"><a href="../../datamodel/basemodel.html#KilnBaseModel.created_at">created_at</a></dd>
-                <dd id="DataGenSampleTask.created_by" class="variable"><a href="../../datamodel/basemodel.html#KilnBaseModel.created_by">created_by</a></dd>
-                <dd id="DataGenSampleTask.model_type" class="variable"><a href="../../datamodel/basemodel.html#KilnBaseModel.model_type">model_type</a></dd>
-                <dd id="DataGenSampleTask.type_name" class="function"><a href="../../datamodel/basemodel.html#KilnBaseModel.type_name">type_name</a></dd>
-                <dd id="DataGenSampleTask.base_filename" class="function"><a href="../../datamodel/basemodel.html#KilnBaseModel.base_filename">base_filename</a></dd>
-                <dd id="DataGenSampleTask.load_from_folder" class="function"><a href="../../datamodel/basemodel.html#KilnBaseModel.load_from_folder">load_from_folder</a></dd>
-                <dd id="DataGenSampleTask.load_from_file" class="function"><a href="../../datamodel/basemodel.html#KilnBaseModel.load_from_file">load_from_file</a></dd>
-                <dd id="DataGenSampleTask.loaded_from_file" class="function"><a href="../../datamodel/basemodel.html#KilnBaseModel.loaded_from_file">loaded_from_file</a></dd>
-                <dd id="DataGenSampleTask.loading_from_file" class="function"><a href="../../datamodel/basemodel.html#KilnBaseModel.loading_from_file">loading_from_file</a></dd>
-                <dd id="DataGenSampleTask.save_to_file" class="function"><a href="../../datamodel/basemodel.html#KilnBaseModel.save_to_file">save_to_file</a></dd>
-                <dd id="DataGenSampleTask.delete" class="function"><a href="../../datamodel/basemodel.html#KilnBaseModel.delete">delete</a></dd>
-                <dd id="DataGenSampleTask.max_schema_version" class="function"><a href="../../datamodel/basemodel.html#KilnBaseModel.max_schema_version">max_schema_version</a></dd>
-
-            </div>
-                                </dl>
-                            </div>
+                </section>
+                <section id="wrap_task_with_guidance">
+                            <input id="wrap_task_with_guidance-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
+<div class="attr function">
+            
+        <span class="def">def</span>
+        <span class="name">wrap_task_with_guidance</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">original_instruction</span><span class="p">:</span> <span class="nb">str</span>, </span><span class="param"><span class="n">guidance</span><span class="p">:</span> <span class="nb">str</span></span><span class="return-annotation">) -> <span class="nb">str</span>:</span></span>
+
+                <label class="view-source-button" for="wrap_task_with_guidance-view-source"><span>View Source</span></label>
+
+    </div>
+    <a class="headerlink" href="#wrap_task_with_guidance"></a>
+            <div class="pdoc-code codehilite"><pre><span></span><span id="wrap_task_with_guidance-189"><a href="#wrap_task_with_guidance-189"><span class="linenos">189</span></a><span class="k">def</span> <span class="nf">wrap_task_with_guidance</span><span class="p">(</span><span class="n">original_instruction</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">guidance</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
+</span><span id="wrap_task_with_guidance-190"><a href="#wrap_task_with_guidance-190"><span class="linenos">190</span></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;Wrap the original instruction with human guidance.</span>
+</span><span id="wrap_task_with_guidance-191"><a href="#wrap_task_with_guidance-191"><span class="linenos">191</span></a>
+</span><span id="wrap_task_with_guidance-192"><a href="#wrap_task_with_guidance-192"><span class="linenos">192</span></a><span class="sd">    Args:</span>
+</span><span id="wrap_task_with_guidance-193"><a href="#wrap_task_with_guidance-193"><span class="linenos">193</span></a><span class="sd">        original_instruction: The original instruction to wrap</span>
+</span><span id="wrap_task_with_guidance-194"><a href="#wrap_task_with_guidance-194"><span class="linenos">194</span></a><span class="sd">        guidance: The human guidance to wrap the instruction with</span>
+</span><span id="wrap_task_with_guidance-195"><a href="#wrap_task_with_guidance-195"><span class="linenos">195</span></a><span class="sd">    &quot;&quot;&quot;</span>
+</span><span id="wrap_task_with_guidance-196"><a href="#wrap_task_with_guidance-196"><span class="linenos">196</span></a>    <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;&quot;&quot;</span><span class="si">{</span><span class="n">original_instruction</span><span class="si">}</span>
+</span><span id="wrap_task_with_guidance-197"><a href="#wrap_task_with_guidance-197"><span class="linenos">197</span></a>
+</span><span id="wrap_task_with_guidance-198"><a href="#wrap_task_with_guidance-198"><span class="linenos">198</span></a><span class="s2"># Special Instructions</span>
+</span><span id="wrap_task_with_guidance-199"><a href="#wrap_task_with_guidance-199"><span class="linenos">199</span></a>
+</span><span id="wrap_task_with_guidance-200"><a href="#wrap_task_with_guidance-200"><span class="linenos">200</span></a><span class="s2">The above instructions are the original instructions for this task. For this execution, we&#39;ve been given additional instructions. Follow both, but prioritize the additional instructions when they conflict. The additional instructions are:</span>
+</span><span id="wrap_task_with_guidance-201"><a href="#wrap_task_with_guidance-201"><span class="linenos">201</span></a><span class="s2">&lt;additional_instructions&gt;</span>
+</span><span id="wrap_task_with_guidance-202"><a href="#wrap_task_with_guidance-202"><span class="linenos">202</span></a><span class="si">{</span><span class="n">guidance</span><span class="si">}</span>
+</span><span id="wrap_task_with_guidance-203"><a href="#wrap_task_with_guidance-203"><span class="linenos">203</span></a><span class="s2">&lt;/additional_instructions&gt;</span>
+</span><span id="wrap_task_with_guidance-204"><a href="#wrap_task_with_guidance-204"><span class="linenos">204</span></a><span class="s2">&quot;&quot;&quot;</span>
+</span></pre></div>
+
+
+            <div class="docstring"><p>Wrap the original instruction with human guidance.</p>
+
+<p>Args:
+    original_instruction: The original instruction to wrap
+    guidance: The human guidance to wrap the instruction with</p>
+</div>
+
+
                 </section>
     </main>
 <script>