Skip to content

Add a prompt interface #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add a prompt interface #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions ml.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Then, the user passes <em>tensor</em> inputs to the <em>graph</em>, computes the
<li>interface <a href="#wasi_nn_errors_0_2_0_rc_2024_06_25"><code>wasi:nn/[email protected]</code></a></li>
<li>interface <a href="#wasi_nn_inference_0_2_0_rc_2024_06_25"><code>wasi:nn/[email protected]</code></a></li>
<li>interface <a href="#wasi_nn_graph_0_2_0_rc_2024_06_25"><code>wasi:nn/[email protected]</code></a></li>
<li>interface <a href="#wasi_nn_prompt_0_2_0_rc_2024_06_25"><code>wasi:nn/[email protected]</code></a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -301,3 +302,36 @@ range from simple to complex (e.g., URLs?) and caching mechanisms of various kin
<ul>
<li><a name="load_by_name.0"></a> result&lt;own&lt;<a href="#graph"><a href="#graph"><code>graph</code></a></a>&gt;, own&lt;<a href="#error"><a href="#error"><code>error</code></a></a>&gt;&gt;</li>
</ul>
<h2><a name="wasi_nn_prompt_0_2_0_rc_2024_06_25"></a>Import interface wasi:nn/[email protected]</h2>
<p>A prompt &quot;session&quot; is encapsulated by a <a href="#context"><code>context</code></a>.</p>
<hr />
<h3>Types</h3>
<h4><a name="graph"></a><code>type graph</code></h4>
<p><a href="#graph"><a href="#graph"><code>graph</code></a></a></p>
<p>
#### <a name="context"></a>`resource context`
<h2>A prompt &quot;session.&quot;</h2>
<h3>Functions</h3>
<h4><a name="init"></a><code>init: func</code></h4>
<p>Initialize a prompt session with a graph.</p>
<p>Note that not all graphs are prompt-ready (see <code>inference</code>); this
function may fail in this case.</p>
<h5>Params</h5>
<ul>
<li><a name="init.graph"></a><a href="#graph"><code>graph</code></a>: own&lt;<a href="#graph"><a href="#graph"><code>graph</code></a></a>&gt;</li>
</ul>
<h5>Return values</h5>
<ul>
<li><a name="init.0"></a> result&lt;own&lt;<a href="#context"><a href="#context"><code>context</code></a></a>&gt;, <code>string</code>&gt;</li>
</ul>
<h4><a name="method_context_compute"></a><code>[method]context.compute: func</code></h4>
<p>Compute an inference request with the given inputs.</p>
<h5>Params</h5>
<ul>
<li><a name="method_context_compute.self"></a><code>self</code>: borrow&lt;<a href="#context"><a href="#context"><code>context</code></a></a>&gt;</li>
<li><a name="method_context_compute.prompt"></a><code>prompt</code>: <code>string</code></li>
</ul>
<h5>Return values</h5>
<ul>
<li><a name="method_context_compute.0"></a> result&lt;<code>string</code>, <code>string</code>&gt;</li>
</ul>
18 changes: 18 additions & 0 deletions wit/wasi-nn.wit
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ world ml {
import tensor;
import graph;
import inference;
import prompt;
import errors;
}

Expand Down Expand Up @@ -132,6 +133,23 @@ interface inference {
}
}

/// A prompt "session" is encapsulated by a `context`.
interface prompt {
use graph.{graph};

/// Initialize a prompt session with a graph.
///
/// Note that not all graphs are prompt-ready (see `inference`); this
/// function may fail in this case.
init: func(graph: graph) -> result<context, string>;

/// A prompt "session."
resource context {
/// Compute an inference request with the given inputs.
compute: func(prompt: string) -> result<string, string>;
}
}

/// TODO: create function-specific errors (https://github.com/WebAssembly/wasi-nn/issues/42)
interface errors {
enum error-code {
Expand Down