PyPI - llm-function - Versions diffs - 0.0.1__py3-none-any.whl - Mend

llm-function 0.0.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (157) hide show

llm_function/mkdocs/site/llm_function_tools/index.html ADDED Viewed

@@ -0,0 +1,622 @@
+<!doctype html>
+<html lang="en" class="no-js">
+  <head>
+      <meta charset="utf-8">
+      <meta name="viewport" content="width=device-width,initial-scale=1">
+        <link rel="prev" href="../release-notes/">
+      <link rel="icon" href="../assets/images/favicon.png">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.30">
+        <title>Llm function tools - Llm function</title>
+      <link rel="stylesheet" href="../assets/stylesheets/main.3cba04c6.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
+        <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
+      <link rel="stylesheet" href="../css/extra.css">
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+  </head>
+    <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="green" data-md-color-accent="green">
+    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
+    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
+    <label class="md-overlay" for="__drawer"></label>
+    <div data-md-component="skip">
+        <a href="#define-typed-tools" class="md-skip">
+          Skip to content
+        </a>
+    </div>
+    <div data-md-component="announce">
+    </div>
+<header class="md-header md-header--shadow" data-md-component="header">
+  <nav class="md-header__inner md-grid" aria-label="Header">
+    <a href=".." title="Llm function" class="md-header__button md-logo" aria-label="Llm function" data-md-component="logo">
+  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
+    </a>
+    <label class="md-header__button md-icon" for="__drawer">
+      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
+    </label>
+    <div class="md-header__title" data-md-component="header-title">
+      <div class="md-header__ellipsis">
+        <div class="md-header__topic">
+          <span class="md-ellipsis">
+            Llm function
+          </span>
+        </div>
+        <div class="md-header__topic" data-md-component="header-topic">
+          <span class="md-ellipsis">
+              Llm function tools
+          </span>
+        </div>
+      </div>
+    </div>
+        <form class="md-header__option" data-md-component="palette">
+    <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="green" data-md-color-accent="green"  aria-label="Switch to dark mode"  type="radio" name="__palette" id="__palette_0">
+      <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a7 7 0 0 0-7 7c0 2.38 1.19 4.47 3 5.74V17a1 1 0 0 0 1 1h6a1 1 0 0 0 1-1v-2.26c1.81-1.27 3-3.36 3-5.74a7 7 0 0 0-7-7M9 21a1 1 0 0 0 1 1h4a1 1 0 0 0 1-1v-1H9v1Z"/></svg>
+      </label>
+    <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="green" data-md-color-accent="green"  aria-label="Switch to light mode"  type="radio" name="__palette" id="__palette_1">
+      <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a7 7 0 0 1 7 7c0 2.38-1.19 4.47-3 5.74V17a1 1 0 0 1-1 1H9a1 1 0 0 1-1-1v-2.26C6.19 13.47 5 11.38 5 9a7 7 0 0 1 7-7M9 21v-1h6v1a1 1 0 0 1-1 1h-4a1 1 0 0 1-1-1m3-17a5 5 0 0 0-5 5c0 2.05 1.23 3.81 3 4.58V16h4v-2.42c1.77-.77 3-2.53 3-4.58a5 5 0 0 0-5-5Z"/></svg>
+      </label>
+</form>
+      <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
+      <label class="md-header__button md-icon" for="__search">
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
+      </label>
+      <div class="md-search" data-md-component="search" role="dialog">
+  <label class="md-search__overlay" for="__search"></label>
+  <div class="md-search__inner" role="search">
+    <form class="md-search__form" name="search">
+      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
+      <label class="md-search__icon md-icon" for="__search">
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
+      </label>
+      <nav class="md-search__options" aria-label="Search">
+        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
+        </button>
+      </nav>
+    </form>
+    <div class="md-search__output">
+      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
+        <div class="md-search-result" data-md-component="search-result">
+          <div class="md-search-result__meta">
+            Initializing search
+          </div>
+          <ol class="md-search-result__list" role="presentation"></ol>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+      <div class="md-header__source">
+        <a href="https://github.com/Kiril-Mordan/adaptive-reusables" title="Go to repository" class="md-source" data-md-component="source">
+  <div class="md-source__icon md-icon">
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
+  </div>
+  <div class="md-source__repository">
+    adaptive-reusables
+  </div>
+</a>
+      </div>
+  </nav>
+</header>
+    <div class="md-container" data-md-component="container">
+      <main class="md-main" data-md-component="main">
+        <div class="md-main__inner md-grid">
+              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
+                <div class="md-sidebar__scrollwrap">
+                  <div class="md-sidebar__inner">
+<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
+  <label class="md-nav__title" for="__drawer">
+    <a href=".." title="Llm function" class="md-nav__button md-logo" aria-label="Llm function" data-md-component="logo">
+  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
+    </a>
+    Llm function
+  </label>
+    <div class="md-nav__source">
+      <a href="https://github.com/Kiril-Mordan/adaptive-reusables" title="Go to repository" class="md-source" data-md-component="source">
+  <div class="md-source__icon md-icon">
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
+  </div>
+  <div class="md-source__repository">
+    adaptive-reusables
+  </div>
+</a>
+    </div>
+  <ul class="md-nav__list" data-md-scrollfix>
+    <li class="md-nav__item">
+      <a href=".." class="md-nav__link">
+  <span class="md-ellipsis">
+    Intro
+  </span>
+      </a>
+    </li>
+    <li class="md-nav__item">
+      <a href="../release-notes/" class="md-nav__link">
+  <span class="md-ellipsis">
+    Release notes
+  </span>
+      </a>
+    </li>
+    <li class="md-nav__item md-nav__item--active">
+      <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
+        <label class="md-nav__link md-nav__link--active" for="__toc">
+  <span class="md-ellipsis">
+    Llm function tools
+  </span>
+          <span class="md-nav__icon md-icon"></span>
+        </label>
+      <a href="./" class="md-nav__link md-nav__link--active">
+  <span class="md-ellipsis">
+    Llm function tools
+  </span>
+      </a>
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+    <label class="md-nav__title" for="__toc">
+      <span class="md-nav__icon md-icon"></span>
+      Table of contents
+    </label>
+    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+        <li class="md-nav__item">
+  <a href="#define-typed-tools" class="md-nav__link">
+    <span class="md-ellipsis">
+      Define typed tools
+    </span>
+  </a>
+</li>
+        <li class="md-nav__item">
+  <a href="#create-a-toolspec-from-a-plain-callable" class="md-nav__link">
+    <span class="md-ellipsis">
+      Create a ToolSpec from a plain callable
+    </span>
+  </a>
+</li>
+        <li class="md-nav__item">
+  <a href="#discover-tools-from-a-module" class="md-nav__link">
+    <span class="md-ellipsis">
+      Discover tools from a module
+    </span>
+  </a>
+</li>
+        <li class="md-nav__item">
+  <a href="#load-tools-from-a-standalone-py-file" class="md-nav__link">
+    <span class="md-ellipsis">
+      Load tools from a standalone .py file
+    </span>
+  </a>
+</li>
+    </ul>
+</nav>
+    </li>
+  </ul>
+</nav>
+                  </div>
+                </div>
+              </div>
+              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
+                <div class="md-sidebar__scrollwrap">
+                  <div class="md-sidebar__inner">
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+    <label class="md-nav__title" for="__toc">
+      <span class="md-nav__icon md-icon"></span>
+      Table of contents
+    </label>
+    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+        <li class="md-nav__item">
+  <a href="#define-typed-tools" class="md-nav__link">
+    <span class="md-ellipsis">
+      Define typed tools
+    </span>
+  </a>
+</li>
+        <li class="md-nav__item">
+  <a href="#create-a-toolspec-from-a-plain-callable" class="md-nav__link">
+    <span class="md-ellipsis">
+      Create a ToolSpec from a plain callable
+    </span>
+  </a>
+</li>
+        <li class="md-nav__item">
+  <a href="#discover-tools-from-a-module" class="md-nav__link">
+    <span class="md-ellipsis">
+      Discover tools from a module
+    </span>
+  </a>
+</li>
+        <li class="md-nav__item">
+  <a href="#load-tools-from-a-standalone-py-file" class="md-nav__link">
+    <span class="md-ellipsis">
+      Load tools from a standalone .py file
+    </span>
+  </a>
+</li>
+    </ul>
+</nav>
+                  </div>
+                </div>
+              </div>
+            <div class="md-content" data-md-component="content">
+              <article class="md-content__inner md-typeset">
+  <h1>Llm function tools</h1>
+<p>Currently intended usage pattern for <code>llm_function_tools</code>:</p>
+<ul>
+<li>define typed tools with <code>@llm_tool</code></li>
+<li>inspect the attached <code>ToolSpec</code></li>
+<li>discover tools from a Python module</li>
+<li>load tools from a standalone <code>.py</code> file</li>
+</ul>
+<pre><code class="language-python">from pathlib import Path
+from tempfile import TemporaryDirectory
+from pydantic import BaseModel, Field
+from llm_function_tools import (
+    discover_tools_in_module,
+    get_tool_spec,
+    llm_tool,
+    load_tools_from_python_file,
+    tool_from_callable,
+)
+</code></pre>
+<h2 id="define-typed-tools">Define typed tools</h2>
+<p>A tool is just a function with one <code>BaseModel</code> input and one <code>BaseModel</code> output. <code>@llm_tool</code> attaches a normalized <code>ToolSpec</code> to the function.</p>
+<pre><code class="language-python">class WeatherInput(BaseModel):
+    city: str = Field(..., description=&quot;City name.&quot;)
+class WeatherOutput(BaseModel):
+    forecast: str = Field(..., description=&quot;Weather forecast.&quot;)
+@llm_tool(tags=[&quot;weather&quot;], metadata={&quot;scope&quot;: &quot;demo&quot;})
+def get_weather(inputs: WeatherInput) -&gt; WeatherOutput:
+    &quot;&quot;&quot;Get current weather for a city.&quot;&quot;&quot;
+    return WeatherOutput(forecast=f&quot;Sunny in {inputs.city}&quot;)
+tool_spec = get_tool_spec(get_weather)
+tool_spec
+</code></pre>
+<pre><code>ToolSpec(func=&lt;function get_weather at 0x7e0640de5360&gt;, name='get_weather', description='Get current weather for a city.', input_model=&lt;class '__main__.WeatherInput'&gt;, output_model=&lt;class '__main__.WeatherOutput'&gt;, metadata={'scope': 'demo'}, tags=['weather'])
+</code></pre>
+<h2 id="create-a-toolspec-from-a-plain-callable">Create a <code>ToolSpec</code> from a plain callable</h2>
+<p>You can also build <code>ToolSpec</code> directly without decorating the function.</p>
+<pre><code class="language-python">class SearchInput(BaseModel):
+    query: str
+class SearchOutput(BaseModel):
+    result: str
+def search_notes(inputs: SearchInput) -&gt; SearchOutput:
+    &quot;&quot;&quot;Search local notes.&quot;&quot;&quot;
+    return SearchOutput(result=f&quot;Found: {inputs.query}&quot;)
+tool_from_callable(search_notes)
+</code></pre>
+<pre><code>ToolSpec(func=&lt;function search_notes at 0x7e0640de5090&gt;, name='search_notes', description='Search local notes.', input_model=&lt;class '__main__.SearchInput'&gt;, output_model=&lt;class '__main__.SearchOutput'&gt;, metadata={}, tags=[])
+</code></pre>
+<h2 id="discover-tools-from-a-module">Discover tools from a module</h2>
+<p>In normal usage, loaders will inspect a Python module or file and collect decorated tools from it.</p>
+<p>In a notebook, <code>__main__</code> behaves as the current module, so we can demonstrate the same discovery flow here.</p>
+<pre><code class="language-python">import __main__
+discovered = discover_tools_in_module(__main__)
+[(tool.name, tool.tags, tool.metadata) for tool in discovered]
+</code></pre>
+<pre><code>[('get_weather', ['weather'], {'scope': 'demo'})]
+</code></pre>
+<h2 id="load-tools-from-a-standalone-py-file">Load tools from a standalone <code>.py</code> file</h2>
+<p>This is closer to the future <code>llm_function</code> use case where tools live outside the runtime module.</p>
+<pre><code class="language-python">tmp_dir = TemporaryDirectory()
+tool_file = Path(tmp_dir.name) / &quot;sample_tools.py&quot;
+tool_file.write_text(
+    &quot;&quot;&quot;
+from pydantic import BaseModel
+from llm_function_tools import llm_tool
+class MathInput(BaseModel):
+    x: int
+class MathOutput(BaseModel):
+    y: int
+@llm_tool(tags=['math'])
+def add_one(inputs: MathInput) -&gt; MathOutput:
+    '''Add one to the input value.'''
+    return MathOutput(y=inputs.x + 1)
+&quot;&quot;&quot;.strip()
+)
+file_tools = load_tools_from_python_file(str(tool_file))
+[(tool.name, tool.description, tool.tags) for tool in file_tools]
+</code></pre>
+<pre><code>[('add_one', 'Add one to the input value.', ['math'])]
+</code></pre>
+<pre><code class="language-python">file_tools
+</code></pre>
+<pre><code>[ToolSpec(func=&lt;function add_one at 0x7e06361ae830&gt;, name='add_one', description='Add one to the input value.', input_model=&lt;class '_llm_function_tools_sample_tools_8306dd8f7421.MathInput'&gt;, output_model=&lt;class '_llm_function_tools_sample_tools_8306dd8f7421.MathOutput'&gt;, metadata={}, tags=['math'])]
+</code></pre>
+<p>The resulting <code>ToolSpec</code> objects are the input that a higher-level runtime such as <code>llm_function</code> can later resolve into runnable tool registries with provenance metadata.</p>
+              </article>
+            </div>
+<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
+        </div>
+      </main>
+        <footer class="md-footer">
+  <div class="md-footer-meta md-typeset">
+    <div class="md-footer-meta__inner md-grid">
+      <div class="md-copyright">
+    Made with
+    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
+      Material for MkDocs
+    </a>
+</div>
+    </div>
+  </div>
+</footer>
+    </div>
+    <div class="md-dialog" data-md-component="dialog">
+      <div class="md-dialog__inner md-typeset"></div>
+    </div>
+    <script id="__config" type="application/json">{"base": "..", "features": [], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
+      <script src="../assets/javascripts/bundle.fe8b6f2b.min.js"></script>
+  </body>
+</html>