# memorySample

A memory sample record carrying label, stage, device, bytesBefore, bytesAfter, and related state.

Last updated: 2026-09-09

Package: compute.profiling | Status: source-declared

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

Collect and describe compute timing, work, and profiling records.

```yh
external thing memorySample
```

- text label: Stores label as text.
- text stage: Stores stage as text.
- text device: Stores device as text.
- int bytesBefore: Stores bytes before as int.
- int bytesAfter: Stores bytes after as int.
- int peakBytes: Stores peak bytes as int.
- int reusedBytes: Stores reused bytes as int.
- text note: Stores note as text.
- memorySample(text label, text stage, text device, int bytesBefore, int bytesAfter, int peakBytes, int reusedBytes, text note): Memory sample.
- DeltaBytes() returns int: Delta bytes.
- HasReuse() returns bool: Has reuse.
- Describe() returns text: Describe.

## Use memorySample

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

Verification: type checked

```yh
using compute.profiling

// Collect and describe compute timing, work, and profiling records.
memorySample sample = memorySample("Player health", "stage", "device", 4, 4, 4, 4, "note")
Console.Log(Text.From(sample.label))

```

Save this beside start.yh as project.mech:

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

[app]
kind = "headless"

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

[[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.profiling--memorySample/usage --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## memorySample.DeltaBytes

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

Verification: type checked

```yh
using compute.profiling

// Delta bytes.
memorySample instance = memorySample("Player health", "stage", "device", 4, 4, 4, 4, "note")
int result = instance.DeltaBytes()
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

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

[app]
kind = "headless"

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

[[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.profiling--memorySample/method-DeltaBytes-9 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## memorySample.HasReuse

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

Verification: type checked

```yh
using compute.profiling

// Has reuse.
memorySample instance = memorySample("Player health", "stage", "device", 4, 4, 4, 4, "note")
bool result = instance.HasReuse()
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

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

[app]
kind = "headless"

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

[[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.profiling--memorySample/method-HasReuse-10 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## memorySample.Describe

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

Verification: type checked

```yh
using compute.profiling

// Describe.
memorySample instance = memorySample("Player health", "stage", "device", 4, 4, 4, 4, "note")
text result = instance.Describe()
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

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

[app]
kind = "headless"

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

[[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.profiling--memorySample/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/profiling/profiling.yh

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