vyre 0.7.2

GPU compute intermediate representation with a standard operation library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

# vyre

Stable facade for Vyre frontend IR, whole-program compiler artifacts, and
authenticated runtime sessions.

## Install

```sh
cargo add vyre
```

## Compile a graph

```rust
use std::collections::BTreeMap;
use vyre::compiler::{compile, CompileRequest, Digest, ExternalFacts, SearchBudget};
use vyre::ir::{
    BufferAccess, BufferDecl, DataType, Program, ProgramGraph, ShapeDim,
    ValueContract, ValueLifetime,
};

let mut graph = ProgramGraph::new();
graph.add_external_value(
    "out",
    ValueContract {
        dtype: DataType::U32,
        shape: vec![ShapeDim::Known(1)],
        access: BufferAccess::WriteOnly,
        lifetime: ValueLifetime::Output,
    },
)?;
graph.add_node(
    "main",
    Program::wrapped(
        vec![BufferDecl::output("out", 0, DataType::U32).with_count(1)],
        [1, 1, 1],
        Vec::new(),
    ),
    Vec::new(),
    Vec::new(),
)?;
let request = CompileRequest::new(
    graph,
    ExternalFacts::new(Digest([0; 32]), BTreeMap::new()),
    SearchBudget::new(1, 1, 1, 0, 1_000_000),
    1_000_000,
)
.validate()?;
let artifact = compile(&request)?;
# Ok::<(), Box<dyn std::error::Error>>(())
```

Attach a payload through a registered target compiler, serialize the resulting
`ArtifactEnvelope`, and construct `ArtifactSession` with the matching backend
registration. Submission uses `BindingSet`; completion returns outputs keyed by
canonical artifact value IDs.

## Public surface

| Path | Owner | Purpose |
|------|-------|---------|
| `vyre::ir` | `vyre-foundation` | Frontend `Program`, `ProgramGraph`, contracts, and validation |
| `vyre::compiler` | `vyre-megakernel` | Compile requests, bounded schedule selection, artifacts, payloads, and target compiler facets |
| `vyre::ArtifactSession` | `vyre-runtime` | Authenticated admission, materialization, submission, and recovery |
| `vyre::PersistentExecutor` | `vyre-runtime` | Retained artifact-backed resident queue execution |
| `vyre::BindingSet` | `vyre-driver` | Typed resource bindings keyed by artifact value identity |

Concrete drivers own target compilation, device acquisition, native
materialization, and submission. The facade does not select a concrete backend
or lower directly to target text.

## Conformance

Pair `vyre` with `vyre-reference` and backend KAT parity tests for a binary
verdict on backend correctness. Reference execution is an explicit oracle, not
a production fallback.

## The book

Documentation and tutorials live in [`docs/`](../docs/). Build the mdBook for
the complete rendered guide.

## License

MIT OR Apache-2.0.

<!-- BEGIN GENERATED CRATE CONTRACT -->
## Crate contract

This section is generated by `python3 scripts/crate_readmes.py --write` from
the crate manifest, release train, ownership registry, and crate-guide metadata.

### Purpose

Expose canonical frontend IR, compiler artifact, runtime submission, and scan product entry points without re-owning backend contracts.

### Boundaries

The `public-facade` owner maintains this `facade` crate at `vyre`.
Its allowed internal production dependencies are: `vyre-driver`, `vyre-driver-cuda`, `vyre-driver-wgpu`, `vyre-foundation`, `vyre-megakernel`, `vyre-runtime`, `vyre-spec`.
Any other normal or build dependency requires an ownership-registry change.

### Minimal real example

Run the checked-in behavior from `vyre/examples/vyre_release_surface.rs`:

```console
CARGO_BUILD_JOBS=1 ./cargo_full run -p vyre --example vyre_release_surface
```

### Features

- Manifest features: `cpu-parity`, `cuda`, `default`, `wgpu`
- Default feature members: None

### Errors and unsupported behavior

Facade artifact workflows preserve structured compiler, admission, submission, and completion errors. Unavailable targets fail closed without backend fallback.

### Testing

Use [`docs/testing/vyre.md`](../docs/testing/vyre.md) for exact commands, Cargo targets, hardware
requirements, evidence outputs, expected skips, and failure semantics.

### Release status

`vyre@0.7.2` is a publishable crate on the current Vyre release train. Publication still requires the release evidence and user-approval gates.

### Ownership

`docs/CRATE_OWNERSHIP.toml` is authoritative for this crate's responsibility
and allowed internal edges. Regenerate `docs/CRATE_GRAPH.md` and
`docs/OWNERSHIP.md` after changing that registry.

### License

Licensed under either of

- Apache License, Version 2.0, or
- MIT license

at your option. See the workspace `LICENSE-APACHE` and `LICENSE-MIT` files.

<!-- END GENERATED CRATE CONTRACT -->