Package io.github.ai4ci.config

Interface ExperimentConfiguration

All Known Implementing Classes:

ImmutableExperimentConfiguration, ModifiableExperimentConfiguration

@Immutable
@Modifiable
public interface ExperimentConfiguration

Field Summary

Fields

Modifier and Type	Field	Description
static final ImmutableExperimentConfiguration	DEFAULT

Method Summary

Modifier and Type	Method	Description
default StateExporter	exporter(Path baseDirectory)
ImmutableBatchConfiguration	getBatchConfig()
default Path	getBatchDirectoryPath(Path baseDirectory)
default List<SetupConfiguration>	getBatchSetupList()	Generate a subset of the experiment setups that are relevant to this SLURM node if there is more than one node.
default List<ExecutionConfiguration>	getExecution()
ImmutableExecutionConfiguration	getExecutionConfig()
int	getExecutionReplications()
List<ImmutableExecutionFacet>	getFacets()
default List<SetupConfiguration>	getSetup()
List<ExperimentFacet.SetupFacet<?>>	getSetupConfig()
int	getSetupReplications()
static ExperimentConfiguration	readConfig(Path file)
default ImmutableExperimentConfiguration	withExecutionConfig(ImmutableExecutionConfiguration config)
default ImmutableExperimentConfiguration	withFacet(String name, PartialExecutionConfiguration... config)
default ImmutableExperimentConfiguration	withSetupConfig(SetupConfiguration config)
default void	writeConfig(Path directoryOrFile)

Field Details

DEFAULT

static final ImmutableExperimentConfiguration DEFAULT

Method Details

getBatchConfig

ImmutableBatchConfiguration getBatchConfig()

getSetupConfig

List<ExperimentFacet.SetupFacet<?>> getSetupConfig()

getSetupReplications

int getSetupReplications()

getExecutionConfig

ImmutableExecutionConfiguration getExecutionConfig()

getFacets

List<ImmutableExecutionFacet> getFacets()

getExecutionReplications

int getExecutionReplications()

getBatchSetupList

default List<SetupConfiguration> getBatchSetupList()

Generate a subset of the experiment setups that are relevant to this SLURM node if there is more than one node. If this is

Returns:

getSetup

default List<SetupConfiguration> getSetup()

getExecution

default List<ExecutionConfiguration> getExecution()

writeConfig

default void writeConfig(Path directoryOrFile)
                  throws com.fasterxml.jackson.core.exc.StreamWriteException,
com.fasterxml.jackson.databind.DatabindException,
IOException

Throws:

com.fasterxml.jackson.core.exc.StreamWriteException

com.fasterxml.jackson.databind.DatabindException

IOException

readConfig

static ExperimentConfiguration readConfig(Path file)
                                   throws com.fasterxml.jackson.core.exc.StreamWriteException,
com.fasterxml.jackson.databind.DatabindException,
IOException

Throws:

com.fasterxml.jackson.core.exc.StreamWriteException

com.fasterxml.jackson.databind.DatabindException

IOException

withSetupConfig

default ImmutableExperimentConfiguration withSetupConfig(SetupConfiguration config)

withExecutionConfig

default ImmutableExperimentConfiguration withExecutionConfig(ImmutableExecutionConfiguration config)

withFacet

default ImmutableExperimentConfiguration withFacet(String name,
 PartialExecutionConfiguration... config)

exporter

default StateExporter exporter(Path baseDirectory)

getBatchDirectoryPath

default Path getBatchDirectoryPath(Path baseDirectory)