# portableKernelContract

A portable kernel contract record carrying name, operationKind, arguments, work, effect, and related state.

Last updated: 2026-09-09

Package: compute.kernels | Status: source-declared

Tags: compute, compute.kernels, cpu, kernels, method, source-example, thing, yeho

Describe reusable compute kernels and their workload contracts.

```yh
external thing portableKernelContract
```

- text name: Stores name as text.
- text operationKind: Stores operation kind as text.
- list of portableKernelArgument arguments: Stores arguments as list of portableKernelArgument.
- portableKernelWorkContract work: Stores work as portableKernelWorkContract.
- text effect: Stores effect as text.
- list of text capabilities: Stores capabilities as list of text.
- bool deterministic: Stores deterministic as bool.
- bool eagerEquivalentRequired: Stores eager equivalent required as bool.
- text specializationKey: Stores specialization key as text.
- portableKernelContract(text name, text operationKind, list of portableKernelArgument arguments, portableKernelWorkContract work, text effect, list of text capabilities, bool deterministic, bool eagerEquivalentRequired, text specializationKey): Portable kernel contract.
- CacheKey() returns text: Cache key.
- Describe() returns text: Describe.

## Use portableKernelContract

A complete small caller. Values are illustrative; check the returned result and package requirements before connecting live resources.

Verification: type checked

```yh
using compute.kernels

// Describe reusable compute kernels and their workload contracts.
portableKernelContract sample = portableKernelContract("Nova", "operation Kind", [], portableKernelWorkContract(1, [], [], "bounds Policy", 4, 1, "barrier Policy", "reduction Kind", "reduction Order"), "effect", [], true, true, "specialization Key")
Console.Log(Text.From(sample.name))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.compute_kernels__portablekernelcontract"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "compute.kernels"
version = "0.1.0"
path = "../../../yeho/packages/compute/kernels"

[[dependencies]]
package = "compute.tensor"
version = "0.1.0"
path = "../../../yeho/packages/compute/tensor"

[[dependencies]]
package = "console"
version = "0.1.0"
path = "../../../yeho/packages/console"

[[dependencies]]
package = "diagnostics"
version = "0.1.0"
path = "../../../yeho/packages/diagnostics"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/compute.kernels--portableKernelContract/usage --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## portableKernelContract.CacheKey

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using compute.kernels

// Cache key.
portableKernelContract instance = portableKernelContract("Nova", "operation Kind", [], portableKernelWorkContract(1, [], [], "bounds Policy", 4, 1, "barrier Policy", "reduction Kind", "reduction Order"), "effect", [], true, true, "specialization Key")
text result = instance.CacheKey()
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.compute_kernels__portablekernelcontract"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "compute.kernels"
version = "0.1.0"
path = "../../../yeho/packages/compute/kernels"

[[dependencies]]
package = "compute.tensor"
version = "0.1.0"
path = "../../../yeho/packages/compute/tensor"

[[dependencies]]
package = "console"
version = "0.1.0"
path = "../../../yeho/packages/console"

[[dependencies]]
package = "diagnostics"
version = "0.1.0"
path = "../../../yeho/packages/diagnostics"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/compute.kernels--portableKernelContract/method-CacheKey-10 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## portableKernelContract.Describe

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using compute.kernels

// Describe.
portableKernelContract instance = portableKernelContract("Nova", "operation Kind", [], portableKernelWorkContract(1, [], [], "bounds Policy", 4, 1, "barrier Policy", "reduction Kind", "reduction Order"), "effect", [], true, true, "specialization Key")
text result = instance.Describe()
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.compute_kernels__portablekernelcontract"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "compute.kernels"
version = "0.1.0"
path = "../../../yeho/packages/compute/kernels"

[[dependencies]]
package = "compute.tensor"
version = "0.1.0"
path = "../../../yeho/packages/compute/tensor"

[[dependencies]]
package = "console"
version = "0.1.0"
path = "../../../yeho/packages/console"

[[dependencies]]
package = "diagnostics"
version = "0.1.0"
path = "../../../yeho/packages/diagnostics"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/compute.kernels--portableKernelContract/method-Describe-11 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


Package presence and a declaration do not establish support on every host. Host services need their platform and lifecycle setup.

Source: yeho/packages/compute/kernels/portable_contract.yh

AI training permission: https://demonhunterlabs.com/ai-use