Skip to content
Crystallize Documentation

Experiment Builder

module crystallize.experiments.experiment_builder

Section titled “module crystallize.experiments.experiment_builder”

class ExperimentBuilder

Section titled “class ExperimentBuilder”

Fluent builder for :class:Experiment.

method ExperimentBuilder.__init__

Section titled “method ExperimentBuilder.__init__”
__init__(name: 'Optional[str]' = None) → None

method ExperimentBuilder.add_step

Section titled “method ExperimentBuilder.add_step”
add_step(step: 'PipelineStep') → 'ExperimentBuilder'

method ExperimentBuilder.build

Section titled “method ExperimentBuilder.build”
build() → Experiment

method ExperimentBuilder.datasource

Section titled “method ExperimentBuilder.datasource”
datasource(datasource: 'DataSource') → 'ExperimentBuilder'

method ExperimentBuilder.description

Section titled “method ExperimentBuilder.description”
description(description: 'str') → 'ExperimentBuilder'

method ExperimentBuilder.hypotheses

Section titled “method ExperimentBuilder.hypotheses”
hypotheses(hypotheses: 'List[Hypothesis]') → 'ExperimentBuilder'

method ExperimentBuilder.initial_ctx

Section titled “method ExperimentBuilder.initial_ctx”
initial_ctx(initial_ctx: 'Dict[str, Any]') → 'ExperimentBuilder'

method ExperimentBuilder.outputs

Section titled “method ExperimentBuilder.outputs”
outputs(outputs: 'List[Artifact]') → 'ExperimentBuilder'

method ExperimentBuilder.pipeline

Section titled “method ExperimentBuilder.pipeline”
pipeline(pipeline: 'Pipeline') → 'ExperimentBuilder'

method ExperimentBuilder.plugins

Section titled “method ExperimentBuilder.plugins”
plugins(plugins: 'List[BasePlugin]') → 'ExperimentBuilder'

method ExperimentBuilder.replicates

Section titled “method ExperimentBuilder.replicates”
replicates(replicates: 'int') → 'ExperimentBuilder'

method ExperimentBuilder.treatments

Section titled “method ExperimentBuilder.treatments”
treatments(treatments: 'List[Treatment]') → 'ExperimentBuilder'