openml.study.OpenMLStudy¶
- class openml.study.OpenMLStudy(study_id: int | None, alias: str | None, benchmark_suite: int | 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] | None, flows: List[int] | None, runs: List[int] | None, setups: List[int] | None)¶
An OpenMLStudy represents the OpenML concept of a study (a collection of runs).
It contains the following information: name, id, description, creation date, creator id and a list of run ids.
According to this list of run ids, the study object receives a list of OpenML object ids (datasets, flows, tasks and setups).
- Parameters:
- study_idint
the study id
- aliasstr (optional)
a string ID, unique on server (url-friendly)
- benchmark_suiteint (optional)
the benchmark suite (another study) upon which this study is ran. can only be active if main entity type is runs.
- 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
- flowslist
a list of flow ids associated with this study
- runslist
a list of run ids associated with this study
- setupslist
a list of setup 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.