Class Provenance

Namespace

DotFly.Core.Checkpoints

Assembly

DotFly.Core.dll

Everything needed to reproduce a checkpoint: where the data came from, which filter selected the neurons, which sign policy produced the edge signs, and the neuron model the checkpoint was built for. Stored as JSON inside the .dfb file.

public sealed class Provenance

Inheritance

object

Provenance

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

BuilderVersion

Version of the builder that produced the file.

public required string BuilderVersion { get; init; }

Property Value

string

BuiltAt

UTC build time.

public required DateTimeOffset BuiltAt { get; init; }

Property Value

DateTimeOffset

Dataset

Source dataset identifier, e.g. male-cns:v1.0 or flywire:v630.

public required string Dataset { get; init; }

Property Value

string

Derivation

Derivation description (e.g. hops=2 from set sugar_GRN_R), else null.

public string? Derivation { get; init; }

Property Value

string

InclusionFilter

Human-readable description of the neuron inclusion filter.

public required string InclusionFilter { get; init; }

Property Value

string

Model

The neuron model the checkpoint targets.

public required NeuronModel Model { get; init; }

Property Value

NeuronModel

Name

Short checkpoint name, e.g. malecns-v1.0-superclass.

public required string Name { get; init; }

Property Value

string

Parent

Name of the parent checkpoint when derived (sub-graph, shuffle, ablation), else null.

public string? Parent { get; init; }

Property Value

string

Seed

Seed of any randomised derivation (shuffles), else null.

public ulong? Seed { get; init; }

Property Value

ulong?

SignPolicy

Name of the SignPolicy that produced the edge signs, or precomputed.

public required string SignPolicy { get; init; }

Property Value

string

SourceEdges

Edge statistics of the source selection before zero-sign edges were dropped, when known.

public EdgeStats? SourceEdges { get; init; }

Property Value

EdgeStats

Sources

Source files with SHA-256 hashes.

public required IReadOnlyList<SourceFile> Sources { get; init; }

Property Value

IReadOnlyList<SourceFile>

Methods

FromJson(string)

Deserialises from JSON.

public static Provenance FromJson(string json)

Parameters

json string

Returns

Provenance

ToJson()

Serialises to JSON (indented).

public string ToJson()

Returns

string