openml.tasks.OpenMLTask

class openml.tasks.OpenMLTask(task_id: int | None, task_type_id: TaskType, task_type: str, data_set_id: int, estimation_procedure_id: int = 1, estimation_procedure_type: str | None = None, estimation_parameters: dict[str, str] | None = None, evaluation_measure: str | None = None, data_splits_url: str | None = None)

OpenML Task object.

Parameters:

task_id: Union[int, None]

Refers to the unique identifier of OpenML task.

task_type_id: TaskType

Refers to the type of OpenML task.

task_type: str

Refers to the OpenML task.

data_set_id: int

Refers to the data.

estimation_procedure_id: int

Refers to the type of estimates used.

estimation_procedure_type: str, default=None

Refers to the type of estimation procedure used for the OpenML task.

estimation_parameters: [Dict[str, str]], default=None

Estimation parameters used for the OpenML task.

evaluation_measure: str, default=None

Refers to the evaluation measure.

data_splits_url: str, default=None

Refers to the URL of the data splits used for the OpenML task.

download_split() → OpenMLSplit

Download the OpenML split for a given task.

get_dataset(**kwargs: Any) → OpenMLDataset

Download dataset associated with task.

Accepts the same keyword arguments as the openml.datasets.get_dataset.

get_split_dimensions() → tuple[int, int, int]

Get the (repeats, folds, samples) of the split for a given task.

get_train_test_split_indices(fold: int = 0, repeat: int = 0, sample: int = 0) → tuple[np.ndarray, np.ndarray]

Get the indices of the train and test splits for a given task.

property id: int | None

Return the OpenML ID of this task.

open_in_browser() → None

Opens the OpenML web page corresponding to this object in your default browser.

property openml_url: str | None

The URL of the object on the server, if it was uploaded, else None.

publish() → OpenMLBase

Publish the object on the OpenML server.

push_tag(tag: str) → None

Annotates this entity with a tag on the server.

Parameters:

tagstr

Tag to attach to the flow.

remove_tag(tag: str) → None

Removes a tag from this entity on the server.

Parameters:

tagstr

Tag to attach to the flow.

classmethod url_for_id(id_: int) → str

Return the OpenML URL for the object of the class entity with the given id.