API¶

Modules¶

`openml.datasets`¶

Dataset Classes¶

`OpenMLDataFeature`(index, name, data_type, ...)	Data Feature (a.k.a.
`OpenMLDataset`(name, description[, ...])	Dataset object.

Dataset Functions¶

`attributes_arff_from_df`(df)	Describe attributes of the dataframe according to ARFF specification.
`check_datasets_active`(dataset_ids[, ...])	Check if the dataset ids provided are active.
`create_dataset`(name, description, creator, ...)	Create a dataset.
`delete_dataset`(dataset_id)	Delete dataset with id dataset_id from the OpenML server.
`get_dataset`(dataset_id[, download_data, ...])	Download the OpenML dataset representation, optionally also download actual data file.
`get_datasets`(dataset_ids[, download_data, ...])	Download datasets.
`list_datasets`([data_id, offset, size, ...])	Return a list of all dataset which are on OpenML.
`list_qualities`()	Return list of data qualities available.
`status_update`(data_id, status)	Updates the status of a dataset to either 'active' or 'deactivated'.
`edit_dataset`(data_id[, description, ...])	Edits an OpenMLDataset.
`fork_dataset`(data_id)	Creates a new dataset version, with the authenticated user as the new owner.

`openml.evaluations`¶

Evaluations Classes¶

OpenMLEvaluation(run_id, task_id, setup_id, ...)

Contains all meta-information about a run / evaluation combination, according to the evaluation/list function

Evaluations Functions¶

`list_evaluations`(function[, offset, size, ...])	List all run-evaluation pairs matching all of the given filters.
`list_evaluation_measures`()	Return list of evaluation measures available.
`list_evaluations_setups`(function[, offset, ...])	List all run-evaluation pairs matching all of the given filters and their hyperparameter settings.

`openml.flows`: Flow Functions¶

Flow Classes¶

OpenMLFlow(name, description, model, ...[, ...])

OpenML Flow.

Flow Functions¶

`assert_flows_equal`(flow1, flow2[, ...])	Check equality of two flows.
`delete_flow`(flow_id)	Delete flow with id flow_id from the OpenML server.
`flow_exists`(name, external_version)	Retrieves the flow id.
`get_flow`(flow_id[, reinstantiate, ...])	Download the OpenML flow for a given flow ID.
`list_flows`([offset, size, tag, output_format])	Return a list of all flows which are on OpenML.

`openml.runs`: Run Functions¶

Run Classes¶

OpenMLRun(task_id, flow_id, dataset_id[, ...])

OpenML Run: result of running a model on an OpenML dataset.

Run Functions¶

`delete_run`(run_id)	Delete run with id run_id from the OpenML server.
`get_run`(run_id[, ignore_cache])	Gets run corresponding to run_id.
`get_runs`(run_ids)	Gets all runs in run_ids list.
`get_run_trace`(run_id)	Get the optimization trace object for a given run id.
`initialize_model_from_run`(run_id)	Initialized a model based on a run_id (i.e., using the exact same parameter settings)
`initialize_model_from_trace`(run_id, repeat, fold)	Initialize a model based on the parameters that were set by an optimization procedure (i.e., using the exact same parameter settings)
`list_runs`([offset, size, id, task, setup, ...])	List all runs matching all of the given filters.
`run_model_on_task`(model, task[, ...])	Run the model on the dataset defined by the task.
`run_flow_on_task`(flow, task[, ...])	Run the model provided by the flow on the dataset defined by task.
`run_exists`(task_id, setup_id)	Checks whether a task/setup combination is already present on the server.

`openml.setups`: Setup Functions¶

Setup Classes¶

`OpenMLParameter`(input_id, flow_id, ...)	Parameter object (used in setup).
`OpenMLSetup`(setup_id, flow_id, parameters)	Setup object (a.k.a.

Setup Functions¶

`get_setup`(setup_id)	Downloads the setup (configuration) description from OpenML
`initialize_model`(setup_id)	Initialized a model based on a setup_id (i.e., using the exact same parameter settings)
`list_setups`([offset, size, flow, tag, ...])	List all setups matching all of the given filters.
`setup_exists`(flow)	Checks whether a hyperparameter configuration already exists on the server.

`openml.study`: Study Functions¶

Study Classes¶

`OpenMLBenchmarkSuite`(suite_id, alias, name, ...)	An OpenMLBenchmarkSuite represents the OpenML concept of a suite (a collection of tasks).
`OpenMLStudy`(study_id, alias, ...)	An OpenMLStudy represents the OpenML concept of a study (a collection of runs).

Study Functions¶

`attach_to_study`(study_id, run_ids)	Attaches a set of runs to a study.
`attach_to_suite`(suite_id, task_ids)	Attaches a set of tasks to a benchmarking suite.
`create_benchmark_suite`(name, description, ...)	Creates an OpenML benchmark suite (collection of entity types, where the tasks are the linked entity)
`create_study`(name, description[, run_ids, ...])	Creates an OpenML study (collection of data, tasks, flows, setups and run), where the runs are the main entity (collection consists of runs and all entities (flows, tasks, etc) that are related to these runs)
`delete_study`(study_id)	Deletes a study from the OpenML server.
`delete_suite`(suite_id)	Deletes a study from the OpenML server.
`detach_from_study`(study_id, run_ids)	Detaches a set of run ids from a study.
`detach_from_suite`(suite_id, task_ids)	Detaches a set of task ids from a suite.
`get_study`(study_id[, arg_for_backwards_compat])	Retrieves all relevant information of an OpenML study from the server.
`get_suite`(suite_id)	Retrieves all relevant information of an OpenML benchmarking suite from the server.
`list_studies`([offset, size, status, ...])	Return a list of all studies which are on OpenML.
`list_suites`([offset, size, status, ...])	Return a list of all suites which are on OpenML.
`update_study_status`(study_id, status)	Updates the status of a study to either 'active' or 'deactivated'.
`update_suite_status`(suite_id, status)	Updates the status of a study to either 'active' or 'deactivated'.

`openml.tasks`: Task Functions¶

Task Classes¶

`OpenMLClassificationTask`(task_type_id, ...)	OpenML Classification object.
`OpenMLClusteringTask`(task_type_id, ...[, ...])	OpenML Clustering object.
`OpenMLLearningCurveTask`(task_type_id, ...[, ...])	OpenML Learning Curve object.
`OpenMLRegressionTask`(task_type_id, ...[, ...])	OpenML Regression object.
`OpenMLSplit`(name, description, split)	OpenML Split object.
`OpenMLSupervisedTask`(task_type_id, ...[, ...])	OpenML Supervised Classification object.
`OpenMLTask`(task_id, task_type_id, task_type, ...)	OpenML Task object.
`TaskType`(value)	An enumeration.

Task Functions¶

`create_task`(task_type, dataset_id, ...[, ...])	Create a task based on different given attributes.
`delete_task`(task_id)	Delete task with id task_id from the OpenML server.
`get_task`(task_id, *dataset_args[, ...])	Download OpenML task for a given task ID.
`get_tasks`(task_ids[, download_data, ...])	Download tasks.
`list_tasks`([task_type, offset, size, tag, ...])	Return a number of tasks having the given tag and task_type

Extensions¶

Extension Classes¶

`Extension`()	Defines the interface to connect machine learning libraries to OpenML-Python.
`sklearn.SklearnExtension`()	Connect scikit-learn to OpenML-Python.

Extension Functions¶

`get_extension_by_flow`(flow[, ...])	Get an extension which can handle the given flow.
`get_extension_by_model`(model[, ...])	Get an extension which can handle the given flow.
`register_extension`(extension)	Register an extension.