Skip to content
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.

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

docs: collection of spec updates for 0.1 #801

Merged
merged 8 commits into from
Jan 9, 2024
Merged
Changes from 6 commits
Commits
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
113 changes: 49 additions & 64 deletions specification/hugr.md
Original file line number Diff line number Diff line change
Expand Up @@ -698,19 +698,16 @@ flowchart

#### `ErrorType`

- There is some type of errors, perhaps just a string, or
`Tuple(USize,String)` with some errorcode, that is returned along with
the fact that the graph/program panicked.
- A type which operations can use to indicate an error occurred.

#### Catch

- At some point we expect to add a first-order `catch` node, somewhat
like a DFG-node. This contains a DSG, and (like a DFG node) has
inputs matching the child DSG; but one output, of type
`Sum(O,ErrorType)` where O is the outputs of the child DSG.
ss2165 marked this conversation as resolved.
Show resolved Hide resolved
- There is also a higher-order `catch` operation in the Tierkreis
extension, taking a graph argument; and `run_circuit` will return the
same way.
- It is also possible to use a higher-order `catch` operation in an
ss2165 marked this conversation as resolved.
Show resolved Hide resolved
extension, taking a graph argument.


### Operation Extensibility
Expand All @@ -719,8 +716,7 @@ flowchart

The goal here is to allow the use of operations and types in the
representation that are user defined, or defined and used by extension
tooling. Here “extension tooling” can be our own, e.g. TKET2 or
Tierkreis. These operations cover various flavours:
tooling. These operations cover various flavours:

- Instruction sets specific to a target.
- Operations that are best expressed in some other format that can be
Expand Down Expand Up @@ -1009,7 +1005,7 @@ There are three classes of type: ``AnyType`` $\supset$ ``CopyableType`` $\supset
notion of equality between values. (While *some* notion of equality is defined on
any type with a binary representation, that if the bits are equal then the value is, the converse is not necessarily true - values that are indistinguishable can have different bit representations.)

For example, a `float` type (defined in an extension) would be a ``CopyableType``, but not an ``EqType``. Also, Hugr "classes" loosely correspond to Tierkreis' notion of "constraints".
For example, a `float` type (defined in an extension) would be a ``CopyableType``, but not an ``EqType``.

**Rows** The `#` is a *row* which is a sequence of zero or more types. Types in the row can optionally be given names in metadata i.e. this does not affect behaviour of the HUGR.

Expand Down Expand Up @@ -1037,8 +1033,8 @@ Tuples and Sums are ``CopyableType`` (respectively, ``EqType``) if all their com

The type of `Function` includes a set of extensions (that is, [Extensions](#extension-implementation)) which are required to execute the graph. Every node in the HUGR is annotated with the set of extensions required to produce its inputs, and the set of extensions required to execute the node; the union of these two must match the set of extensions on each successor node.

Keeping track of the extension requirements like this allows extension designers and backends
(like tierkreis) to control how/where a module is run.
Keeping track of the extension requirements like this allows extension designers
and backends to control how/where a module is run.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is backends really the right word here? Typically I think this kind of check would be done by the frontend in order to avoid making an impossible request to a backend (i.e. "run this" when the backend can't)...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

went with "third-party tooling"


Concretely, if a plugin writer adds an extension
*X*, then some function from
Expand All @@ -1047,8 +1043,8 @@ a plugin needs to provide a mechanism to convert the
requirement before it can interface with other plugins which don’t know
about *X*.

A Tierkreis runtime could be connected to workers which provide means of
running different extensions. By the same mechanism, Tierkreis can reason
A runtime could have access to means of
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fantastically vague and non-prescriptive, love it :)

running different extensions. By the same mechanism, the runtime can reason
about where to run different parts of the graph by inspecting their
extension requirements.

Expand Down Expand Up @@ -1557,8 +1553,29 @@ implementation of this design document is available on GitHub.

## Standard Library

`panic`: panics unconditionally; no inputs, any type of outputs (these
are never produced)
A collection of extensions form the "standard library" for HUGR, and are defined
in this repository.

### Prelude

The prelude extension is assumed to be valid and available in all contexts, and
so must be supported by all third-party tooling.

#### Types

`usize`: a positive integer size type.

`array<N, T>`: a known-size (N) array of type T.

`qubit`: a linear (non-copyable) qubit type.

`error`: error type. See [`ErrorType`](#errortype).

### Operations
| Name | Inputs | Outputs | Meaning |
|-------------------|-----------|---------------|-----------------------------------------------------------------|
| `new_array<N, T>` | `T` x N | `array<N, T>` | Create an array from all the inputs |
| `panic` | ErrorType | - | Immediately end execution and pass contents of error to context |

### Logic Extension

Expand All @@ -1578,10 +1595,11 @@ The following operations are defined:
Note that an `and<0>` operation produces the constant value "true" and an
`or<0>` operation produces the constant value "false".

### Arithmetic Extension
### Arithmetic Extensions

The Arithmetic Extension provides types and operations for integer and
floating-point operations.
Types and operations for integer and
floating-point operations are provided by a collection of extensions under the
namespace `arithmetic`.

We largely adopt (a subset of) the definitions of
[WebAssembly 2.0](https://webassembly.github.io/spec/core/index.html),
Expand All @@ -1593,6 +1611,8 @@ A few additonal operations not included in WebAssembly are also
specified, and there are some other small differences (highlighted
below).

### `arithmetic.int.types`
ss2165 marked this conversation as resolved.
Show resolved Hide resolved

The `int<N>` type is parametrized by its width `N`, which is a positive
integer.

Expand All @@ -1612,12 +1632,9 @@ either differs from or is not part of the
[WebAssembly](https://webassembly.github.io/spec/core/exec/numerics.html)
specification.

Const nodes:
### `arithmetic.int`
ss2165 marked this conversation as resolved.
Show resolved Hide resolved

| Name | Inputs | Outputs | Meaning |
| ---------------------- | ------ | -------- | --------------------------------------------------------------------- |
| `iconst_u<N, x>`( \* ) | none | `int<N>` | const node producing unsigned value x (where 0 \<= x \< 2^N) |
| `iconst_s<N, x>`( \* ) | none | `int<N>` | const node producing signed value x (where -2^(N-1) \<= x \< 2^(N-1)) |
This extension defines operations on the integer types.

Casts:

Expand Down Expand Up @@ -1679,17 +1696,22 @@ Other operations:
| `irotl<N,M>`( \* ) | `int<N>`, `int<M>` | `int<N>` | rotate first input left by k bits where k is unsigned interpretation of second input (leftmost bits replace rightmost bits) |
| `irotr<N,M>`( \* ) | `int<N>`, `int<M>` | `int<N>` | rotate first input right by k bits where k is unsigned interpretation of second input (rightmost bits replace leftmost bits) |


### `arithmetic.float.types`
ss2165 marked this conversation as resolved.
Show resolved Hide resolved

The `float64` type represents IEEE 754-2019 floating-point data of 64
bits.


### `arithmetic.float`
ss2165 marked this conversation as resolved.
Show resolved Hide resolved

Floating-point operations are defined as follows. All operations below
follow
[WebAssembly](https://webassembly.github.io/spec/core/exec/numerics.html#floating-point-operations)
except where stated.

| Name | Inputs | Outputs | Meaning |
| ----------------- | -------------------- | --------- | ------------------------------------------------------------------------ |
| `fconst<x>`( \* ) | none | `float64` | const node producing a float |
| `feq`( \* ) | `float64`, `float64` | `bool` | equality test (as WASM but with 0 and 1 interpreted as `bool`) |
| `fne`( \* ) | `float64`, `float64` | `bool` | inequality test (as WASM but with 0 and 1 interpreted as `bool`) |
| `flt`( \* ) | `float64`, `float64` | `bool` | "less than" (as WASM but with 0 and 1 interpreted as `bool`) |
Expand All @@ -1707,6 +1729,9 @@ except where stated.
| `ffloor` | `float64` | `float64` | floor |
| `fceil` | `float64` | `float64` | ceiling |

### `arithmetic.conversions`
ss2165 marked this conversation as resolved.
Show resolved Hide resolved


Conversions between integers and floats:

| Name | Inputs | Outputs | Meaning |
Expand All @@ -1716,46 +1741,6 @@ Conversions between integers and floats:
| `convert_u<N>` | `int<N>` | `float64` | unsigned int to float |
| `convert_s<N>` | `int<N>` | `float64` | signed int to float |

### Higher-order (Tierkreis) Extension

In **some** contexts, notably the Tierkreis runtime, higher-order
operations allow graphs to be valid dataflow values, and be executed.
These operations allow this.

- `CallIndirect`: Call a function indirectly. Like `Call`, but the
first input is a standard dataflow function type. This is essentially
`eval` in Tierkreis.
- `catch`: like `CallIndirect`, the first argument is of type
`Function[R]<I,O>` and the rest of the arguments are of type `I`.
However the result is not `O` but `Sum(O,ErrorType)`
- `parallel`, `sequence`, `partial`? Note that these could be executed
in first order graphs as straightforward (albeit expensive)
manipulations of Graph `struct`s/protobufs\!

$\displaystyle{\frac{\mathrm{body} : [R] \textbf{Function}[R]([R] \textrm{Var}(I), [R] \textrm{Sum}(\textrm{Var}(I), \textrm{Var}(O))) \quad v : [R] \textrm{Var}(I)}{\textrm{loop}(\mathrm{body}, v) : [R] \textrm{Var}(O)}}$

**loop** - In order to run the *body* graph, we need the extensions
R that the graph requires, so
calling the **loop** function requires those same extensions. Since the
result of the body is fed into the input of the graph, it needs to have
the same extension requirements on its inputs and outputs. We require
that *v* is lifted to have extension requirement
R so that it matches the type
of input to the next iterations of the loop.

$\displaystyle{\frac{\Theta : [R] \textbf{Function}[R](\vec{X}, \vec{Y}) \quad \vec{x} : [R] \vec{X}}{\textbf{call\\_indirect}(\Theta, \vec{x}) : [R] \vec{Y}}}$

**CallIndirect** - This has the same feature as **loop**: running a
graph requires its extensions.

$\displaystyle{\frac{}{\textbf{load\\_const} \langle \textbf{Function}[R](\vec{I}, \vec{O}) \rangle (\mathrm{name}) : [\emptyset] \textbf{Function}[R](\vec{I}, \vec{O})}}$

**load_const** - For operations which instantiate a graph (**load\_const**
and **Call**) the functions are given an extra parameter at graph
construction time which corresponds to the function type that they are
meant to instantiate. This type will be given by a typeless edge from
the graph in question to the operation, with the graph’s type added as
an edge weight.

## Glossary

Expand Down