Returns a specification to start this module under a supervisor.

See Supervisor.

@spec configure(String.t(), map()) :: :ok | {:error, term()}

Configure an existing experiment with the given parameters.

Parameters

• experiment_id - ID of the experiment to configure
• config - Configuration parameters for the experiment

Returns

• :ok - If the experiment was configured successfully
• {:error, reason} - If there was an error configuring the experiment

Examples

iex> config = %{
...>   runs: 5,
...>   generations: 50,
...>   population_size: 100,
...>   morphology: :xor,
...>   selection_method: :tournament,
...>   backup_flag: true
...> }
iex> ExperimentManager.configure("experiment_1621234567890", config)
:ok

@spec export_results(String.t(), String.t(), atom()) :: :ok | {:error, term()}

Export experiment results to a file.

Parameters

• experiment_id - ID of the experiment to export
• file_path - Path to save the results to
• format - Format to export in (:csv, :json, or :binary)

Returns

• :ok - If the results were exported successfully
• {:error, reason} - If there was an error exporting the results

Examples

iex> ExperimentManager.export_results("experiment_1621234567890", "results.json", :json)
:ok

@spec get_best_solution(String.t()) :: {:ok, map()} | {:error, term()}

Get the best solution from an experiment.

Parameters

• experiment_id - ID of the experiment to get the best solution from

Returns

• {:ok, solution} - Best solution found in the experiment
• {:error, reason} - If there was an error getting the best solution

Examples

iex> ExperimentManager.get_best_solution("experiment_1621234567890")
{:ok, %{
  fitness: 0.98,
  genotype: %{...},
  phenotype: %{...}
}}

@spec list_active() :: {:ok, [String.t()]} | {:error, term()}

Get all active experiments.

Returns

• {:ok, [experiment_id]} - List of active experiment IDs
• {:error, reason} - If there was an error getting the active experiments

Examples

iex> ExperimentManager.list_active()
{:ok, ["experiment_1621234567890", "experiment_1621234567891"]}

@spec list_all() :: {:ok, [map()]} | {:error, term()}

Get a list of all experiments.

Returns

• {:ok, [experiment]} - List of all experiments with their basic information
• {:error, reason} - If there was an error getting the experiments

Examples

iex> ExperimentManager.list_all()
{:ok, [
  %{id: "experiment_1621234567890", name: "XOR Experiment", status: :completed},
  %{id: "experiment_1621234567891", name: "FX Experiment", status: :in_progress}
]}

@spec new_experiment(String.t()) :: {:ok, String.t()} | {:error, term()}

Create a new experiment with the given name.

Parameters

• name - Name of the experiment

Returns

• {:ok, experiment_id} - Experiment ID of the created experiment
• {:error, reason} - If there was an error creating the experiment

Examples

iex> ExperimentManager.new_experiment("XOR Experiment")
{:ok, "experiment_1621234567890"}

Get the configured population manager module. This is used primarily for testing to allow mocks.

@spec run() :: :ok | {:error, term()}

Start a new experiment run with default parameters. This creates a default experiment and starts it immediately.

Returns

• :ok - If the run was started successfully
• {:error, reason} - If there was an error starting the run

Set the population manager module. This is used primarily for testing to allow mocks.

@spec start(String.t()) :: :ok | {:error, term()}

Start an experiment with the given ID.

Parameters

• experiment_id - ID of the experiment to start

Returns

• :ok - If the experiment was started successfully
• {:error, reason} - If there was an error starting the experiment

Examples

iex> ExperimentManager.start("experiment_1621234567890")
:ok

@spec start_evaluation(String.t(), function() | atom()) :: :ok | {:error, term()}

Set the fitness function for evaluating solutions in an experiment.

Parameters

• experiment_id - ID of the experiment
• fitness_function - Function to evaluate fitness of solutions

Returns

• :ok - If the fitness function was set successfully
• {:error, reason} - If there was an error setting the fitness function

Examples

iex> fitness_fn = fn solution -> solution.output == [0, 1, 1, 0] end
iex> ExperimentManager.start_evaluation("experiment_1621234567890", fitness_fn)
:ok

@spec start_link(keyword()) :: GenServer.on_start()

Start the ExperimentManager as a linked process.

@spec status(String.t()) ::
  {:not_started, map()}
  | {:in_progress, map()}
  | {:completed, map()}
  | {:error, term()}

Get the status of an experiment.

Parameters

• experiment_id - ID of the experiment to get status for

Returns

• {:in_progress, status} - If the experiment is in progress, with status details
• {:completed, results} - If the experiment is completed, with results
• {:error, reason} - If there was an error getting the status

Examples

iex> ExperimentManager.status("experiment_1621234567890")
{:in_progress, %{
  run: 2,
  total_runs: 5,
  generation: 45,
  generations: 50,
  best_fitness: 0.95,
  avg_fitness: 0.72
}}

@spec stop(String.t()) :: :ok | {:error, term()}

Stop an experiment.

Parameters

• experiment_id - ID of the experiment to stop

Returns

• :ok - If the experiment was stopped successfully
• {:error, reason} - If there was an error stopping the experiment

Examples

iex> ExperimentManager.stop("experiment_1621234567890")
:ok