d3m.metadata.pipeline_run module

class d3m.metadata.pipeline_run.PipelineRun(pipeline, problem_description=None, *, phase, context, environment, random_seed, previous_pipeline_run=None, is_standard_pipeline=False, users=None)[source]

Bases: object

METHOD_CALLS = 'method_calls'[source]
STEPS = 'steps'[source]
add_input_dataset(dataset)[source]
Return type

None

add_method_call_to_primitive_step(primitive_step_id, method_name, *, runtime_arguments=None, environment=None)[source]
Return type

Tuple[int, int]

add_primitive_step(step)[source]
Return type

int

add_subpipeline_step(subpipeline_run)[source]
Return type

int

get_id()[source]
Return type

str

get_method_call_logging_callback(step_and_method_call_id)[source]
Return type

Callable

is_failed()[source]
Return type

bool

classmethod json_structure_equals(pipeline_run1, pipeline_run2)[source]

Checks whether two pipeline runs in a JSON structure are equal. This ignores the pipeline run id and all timestamps.

Return type

bool

method_call_failed(step_and_method_call_id, message=None)[source]
Return type

None

method_call_started(step_and_method_call_id)[source]
Return type

None

method_call_successful(step_and_method_call_id, message=None)[source]
Return type

None

run_failed(message=None)[source]
Return type

None

run_started()[source]
Return type

None

run_successful(message=None)[source]
Return type

None

set_data_preparation_pipeline_run(data_preparation_pipeline_run)[source]
Return type

None

set_fold_group(fold_group_id, fold)[source]
Return type

None

set_method_call_result_metadata(step_and_method_call_id, result)[source]
Return type

None

set_predictions(predictions)[source]
Return type

None

set_primitive_step_hyperparams(primitive_step_id, hyperparams, pipeline_hyperparams)[source]
Return type

None

set_primitive_step_random_seed(primitive_step_id, random_seed)[source]
Return type

None

set_scores(scores, metrics)[source]
Return type

None

set_scoring_pipeline_run(scoring_pipeline_run, scoring_datasets=None)[source]
Return type

None

step_failed(step_id, message=None)[source]
Return type

None

step_started(step_id)[source]
Return type

None

step_successful(step_id, message=None)[source]
Return type

None

to_json_structure()[source]
Return type

Dict

to_yaml(file, *, appending=False, **kwargs)[source]
Return type

Optional[str]

class d3m.metadata.pipeline_run.User(id_, chosen=False, rationale=None)[source]

Bases: dict

class d3m.metadata.pipeline_run.RuntimeEnvironment(*, worker_id=None, cpu_resources=None, memory_resources=None, gpu_resources=None, reference_benchmarks=None, reference_engine_version=None, engine_version=None, base_docker_image=None, docker_image=None)[source]

Bases: dict