Interface IExperiment

Namespace

AiDotNet.Interfaces

Assembly

AiDotNet.dll

Represents a machine learning experiment that groups related training runs.

public interface IExperiment

Remarks

For Beginners: An experiment is a container for organizing related training runs. Think of it like a folder that groups all the attempts you make at solving a particular machine learning problem. For example, you might have an experiment called "Customer Churn Prediction" that contains all your different attempts at building a churn prediction model.

Properties

CreatedAt

Gets the timestamp when the experiment was created.

DateTime CreatedAt { get; }

Property Value

DateTime

Description

Gets or sets the description of the experiment.

string? Description { get; set; }

Property Value

string

ExperimentId

Gets the unique identifier for this experiment.

string ExperimentId { get; }

Property Value

string

LastUpdatedAt

Gets the timestamp of the last update to the experiment.

DateTime LastUpdatedAt { get; }

Property Value

DateTime

Name

Gets or sets the name of the experiment.

string Name { get; set; }

Property Value

string

Status

Gets the current status of the experiment.

string Status { get; }

Property Value

string

Tags

Gets or sets tags associated with the experiment.

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

Property Value

Dictionary<string, string>

Remarks

For Beginners: Tags are key-value pairs that help you organize and find experiments. For example, you might tag experiments with "team=data-science" or "priority=high".

Methods

Archive()

Archives this experiment, making it read-only.

void Archive()

Remarks

For Beginners: Archiving an experiment prevents accidental modifications while keeping the data available for reference.

Restore()

Restores this experiment from archived status.

void Restore()