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:

target_namestr (optional)

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: str = 'array') → ndarray | DataFrame | 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() → OpenMLDataset

Download dataset associated with task

property id: int | None

The id of the entity, it is unique for its entity type.

open_in_browser()

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.

push_tag(tag: str)

Annotates this entity with a tag on the server.

Parameters:

tagstr

Tag to attach to the flow.

remove_tag(tag: str)

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.