Class ShakespeareFederatedBenchmarkOptions

Namespace

AiDotNet.Configuration

Assembly

AiDotNet.dll

Configuration options for running the Shakespeare LEAF federated benchmark suite.

public sealed class ShakespeareFederatedBenchmarkOptions

Inheritance

object

ShakespeareFederatedBenchmarkOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Shakespeare is a federated next-character prediction benchmark. LEAF stores the dataset as JSON where each "user" corresponds to a federated client and each sample is a fixed-length text window with the next character as the label.

For Beginners: You provide the train/test JSON files, and AiDotNet loads the per-user partitions, tokenizes the character sequences, and evaluates your model.

Properties

LoadOptions

Gets or sets load options controlling how many users/clients are loaded.

public LeafFederatedDatasetLoadOptions LoadOptions { get; set; }

Property Value

LeafFederatedDatasetLoadOptions

MaxSamplesPerUser

Gets or sets the maximum number of samples to use per user/client (null uses all available).

public int? MaxSamplesPerUser { get; set; }

Property Value

int?

SequenceLength

Gets or sets the fixed character window length used as model input.

public int? SequenceLength { get; set; }

Property Value

int?

Remarks

LEAF uses 80 by default, but this can be smaller for CI or experimentation.

TestFilePath

Gets or sets the optional path to the Shakespeare test split JSON file.

public string? TestFilePath { get; set; }

Property Value

string

Remarks

If null, the suite will evaluate on the train split (CI/local-only convenience).

TrainFilePath

Gets or sets the path to the Shakespeare train split JSON file.

public string? TrainFilePath { get; set; }

Property Value

string