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

kiln_ai-0.13.0/.python-version

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

kiln_ai-0.12.0/README.md → kiln_ai-0.13.0/PKG-INFO

@@ -1,3 +1,35 @@
+Metadata-Version: 2.4
+Name: kiln-ai
+Version: 0.13.0
+Summary: Kiln AI
+Project-URL: Homepage, https://getkiln.ai
+Project-URL: Repository, https://github.com/Kiln-AI/kiln
+Project-URL: Documentation, https://kiln-ai.github.io/Kiln/kiln_core_docs/kiln_ai.html
+Project-URL: Issues, https://github.com/Kiln-AI/kiln/issues
+Author-email: "Steve Cosman, Chesterfield Laboratories Inc" <scosman@users.noreply.github.com>
+License-File: LICENSE.txt
+Classifier: Intended Audience :: Developers
+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: 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
+
 # Kiln AI Core Library
 
 <p align="center">
@@ -40,6 +72,7 @@ The library has a [comprehensive set of docs](https://kiln-ai.github.io/Kiln/kil
   - [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
@@ -227,7 +260,7 @@ 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 (epemerial tasks don't save their result to disk)
+#  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}")
@@ -236,6 +269,49 @@ for run in task.runs():
 
 ```
 
+### 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.12.0/PKG-INFO → kiln_ai-0.13.0/README.md

@@ -1,35 +1,3 @@
-Metadata-Version: 2.4
-Name: kiln-ai
-Version: 0.12.0
-Summary: Kiln AI
-Project-URL: Homepage, https://getkiln.ai
-Project-URL: Repository, https://github.com/Kiln-AI/kiln
-Project-URL: Documentation, https://kiln-ai.github.io/Kiln/kiln_core_docs/kiln_ai.html
-Project-URL: Issues, https://github.com/Kiln-AI/kiln/issues
-Author-email: "Steve Cosman, Chesterfield Laboratories Inc" <scosman@users.noreply.github.com>
-License-File: LICENSE.txt
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.10
-Requires-Dist: coverage>=7.6.4
-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: 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: typing-extensions>=4.12.2
-Description-Content-Type: text/markdown
-
 # Kiln AI Core Library
 
 <p align="center">
@@ -72,6 +40,7 @@ The library has a [comprehensive set of docs](https://kiln-ai.github.io/Kiln/kil
   - [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
@@ -259,7 +228,7 @@ 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 (epemerial tasks don't save their result to disk)
+#  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}")
@@ -268,6 +237,49 @@ for run in task.runs():
 
 ```
 
+### 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.12.0 → 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>
 
 
@@ -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>
 
 
@@ -1058,6 +1079,45 @@ method.</p>
 
                             </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>
     function escapeHTML(html) {