Class Experiment

Namespace

AiDotNet.Models

Assembly

AiDotNet.dll

Represents a machine learning experiment that groups related training runs.

public class Experiment : IExperiment

Inheritance

object

Experiment

Implements

IExperiment

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

For Beginners: An experiment is a container for organizing related training runs. It helps you group all attempts at solving a particular ML problem together.

Constructors

Experiment(string, string?, Dictionary<string, string>?)

Initializes a new instance of the Experiment class.

public Experiment(string name, string? description = null, Dictionary<string, string>? tags = null)

Parameters

name string

The name of the experiment.

description string

Optional description.

tags Dictionary<string, string>

Optional tags.

Properties

CreatedAt

Gets the timestamp when the experiment was created.

[JsonProperty]
public DateTime CreatedAt { get; }

Property Value

DateTime

Description

Gets or sets the description of the experiment.

public string? Description { get; set; }

Property Value

string

ExperimentId

Gets the unique identifier for this experiment.

[JsonProperty]
public string ExperimentId { get; }

Property Value

string

LastUpdatedAt

Gets the timestamp of the last update to the experiment.

[JsonProperty]
public DateTime LastUpdatedAt { get; }

Property Value

DateTime

Name

Gets or sets the name of the experiment.

public string Name { get; set; }

Property Value

string

Exceptions

ArgumentNullException

Thrown when value is null.

ArgumentException

Thrown when value is empty or whitespace.

Status

Gets the current status of the experiment.

[JsonProperty]
public string Status { get; }

Property Value

string

Tags

Gets or sets tags associated with the experiment.

public Dictionary<string, string> Tags { get; set; }

Property Value

Dictionary<string, string>

Methods

Archive()

Archives this experiment, making it read-only.

public void Archive()

Restore()

Restores this experiment from archived status.

public void Restore()