openml.study.OpenMLBenchmarkSuite¶
- class openml.study.OpenMLBenchmarkSuite(suite_id: int | None, alias: str | None, name: str, description: str, status: str | None, creation_date: str | None, creator: int | None, tags: List[Dict] | None, data: List[int] | None, tasks: List[int])¶
An OpenMLBenchmarkSuite represents the OpenML concept of a suite (a collection of tasks).
It contains the following information: name, id, description, creation date, creator id and the task ids.
According to this list of task ids, the suite object receives a list of OpenML object ids (datasets).
- Parameters:
- suite_idint
the study id
- aliasstr (optional)
a string ID, unique on server (url-friendly)
- main_entity_typestr
the entity type (e.g., task, run) that is core in this study. only entities of this type can be added explicitly
- namestr
the name of the study (meta-info)
- descriptionstr
brief description (meta-info)
- statusstr
Whether the study is in preparation, active or deactivated
- creation_datestr
date of creation (meta-info)
- creatorint
openml user id of the owner / creator
- tagslist(dict)
The list of tags shows which tags are associated with the study. Each tag is a dict of (tag) name, window_start and write_access.
- datalist
a list of data ids associated with this study
- taskslist
a list of task ids associated with this study
- 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.