openml.tasks.OpenMLClusteringTask

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

OpenML Clustering object.

Parameters:

task_type_idTaskType

Task type ID of the OpenML clustering task.

task_typestr

Task type of the OpenML clustering task.

data_set_idint

ID of the OpenML dataset used in clustering the task.

estimation_procedure_idint, default=None

ID of the OpenML estimation procedure.

task_idUnion[int, None]

ID of the OpenML clustering task.

estimation_procedure_typestr, default=None

Type of the OpenML estimation procedure used in the clustering task.

estimation_parametersdict, default=None

Parameters used by the OpenML estimation procedure.

data_splits_urlstr, default=None

URL of the OpenML data splits for the clustering task.

evaluation_measurestr, default=None

Evaluation measure used in the clustering task.

target_namestr, default=None

Name of the target feature (class) that is not part of the feature set for the clustering task.

download_split() → OpenMLSplit

Download the OpenML split for a given task.

get_X(dataset_format: Literal['array', 'dataframe'] = 'array') → np.ndarray | pd.DataFrame | scipy.sparse.spmatrix

Get data associated with the current task.

Parameters:

dataset_formatstr

Data structure of the returned data. See openml.datasets.OpenMLDataset.get_data() for possible options.

Returns:

tuple - X and y

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.