openml.study.get_study¶

openml.study.get_study(study_id: int | str, arg_for_backwards_compat: str | None = None) → OpenMLStudy¶

Retrieves all relevant information of an OpenML study from the server.

Parameters:

study idint, str

study id (numeric or alias)

arg_for_backwards_compatstr, optional

The example given in https://arxiv.org/pdf/1708.03731.pdf uses an older version of the API which required specifying the type of study, i.e. tasks. We changed the implementation of studies since then and split them up into suites (collections of tasks) and studies (collections of runs) so this argument is no longer needed.

Returns:

OpenMLStudy

The OpenML study object