Update all files

Author: satvshr

examples/Advanced/datasets_tutorial.py

@@ -139,7 +139,7 @@
 # only for the dataset owner. Further, critical fields cannot be edited if the dataset has any
 # tasks associated with it. To edit critical fields of a dataset (without tasks) owned by you,
 # configure the API key:
-# openml.config._config.apikey = 'FILL_IN_OPENML_API_KEY'
+# openml.config.apikey = 'FILL_IN_OPENML_API_KEY'
 # This example here only shows a failure when trying to work on a dataset not owned by you:
 
 # %%

examples/Basics/introduction_tutorial.py

@@ -35,7 +35,7 @@
 # %%
 import openml
 
-openml.config._config.apikey = "YOURKEY"
+openml.config.apikey = "YOURKEY"
 
 # %% [markdown]
 # ## Caching
@@ -52,4 +52,4 @@
 # %%
 import openml
 
-openml.config.set_root_cache_directory("YOURDIR")
+openml.config.set_root_cache_directory("YOURDIR")

examples/_external_or_deprecated/benchmark_with_optunahub.py

@@ -44,7 +44,7 @@
 # account (you don't need one for anything else, just to upload your results),
 # go to your profile and select the API-KEY.
 # Or log in, and navigate to https://www.openml.org/auth/api-key
-openml.config._config.apikey = ""
+openml.config.apikey = ""
 ############################################################################
 # Prepare for preprocessors and an OpenML task
 # ============================================
@@ -95,7 +95,7 @@ def objective(trial: optuna.Trial) -> Pipeline:
     run = openml.runs.run_model_on_task(pipe, task=task_id, avoid_duplicate_runs=False)
 
     logger.log(1, f"Model has been trained - {run}")
-    if openml.config._config.apikey != "":
+    if openml.config.apikey != "":
         try:
             run.publish()
 

examples/_external_or_deprecated/flow_id_tutorial.py

@@ -16,7 +16,7 @@
 
 # %%
 openml.config.start_using_configuration_for_example()
-openml.config._config.server = "https://api.openml.org/api/v1/xml"
+openml.config.server = "https://api.openml.org/api/v1/xml"
 
 # %%
 # Defining a classifier

openml/__init__.py

@@ -18,9 +18,11 @@
 # License: BSD 3-Clause
 from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
 from . import (
     _api_calls,
-    config,
+    config as _config_module,
     datasets,
     evaluations,
     exceptions,
@@ -49,6 +51,11 @@
     OpenMLTask,
 )
 
+if TYPE_CHECKING:
+    from .config import OpenMLConfigManager
+
+config: OpenMLConfigManager = _config_module._config
+
 
 def populate_cache(
     task_ids: list[int] | None = None,

openml/_api_calls.py

@@ -12,7 +12,7 @@
 import xml
 import zipfile
 from pathlib import Path
-from typing import Dict, Tuple, Union
+from typing import Dict, Tuple, Union, cast
 
 import minio
 import requests
@@ -71,7 +71,7 @@ def resolve_env_proxies(url: str) -> str | None:
 
 
 def _create_url_from_endpoint(endpoint: str) -> str:
-    url = config._config.server
+    url = cast(str, config.server)
     if not url.endswith("/"):
         url += "/"
     url += endpoint
@@ -172,7 +172,7 @@ def _download_minio_file(
             bucket_name=bucket,
             object_name=object_name,
             file_path=str(destination),
-            progress=ProgressBar() if config._config.show_progress else None,
+            progress=ProgressBar() if config.show_progress else None,
             request_headers=_HEADERS,
         )
         if destination.is_file() and destination.suffix == ".zip":
@@ -301,7 +301,8 @@ def _file_id_to_url(file_id: int, filename: str | None = None) -> str:
     Presents the URL how to download a given file id
     filename is optional
     """
-    openml_url = config._config.server.split("/api/")
+    openml_server = cast(str, config.server)
+    openml_url = openml_server.split("/api/")
     url = openml_url[0] + f"/data/download/{file_id!s}"
     if filename is not None:
         url += "/" + filename
@@ -317,7 +318,7 @@ def _read_url_files(
     and sending file_elements as files
     """
     data = {} if data is None else data
-    data["api_key"] = config._config.apikey
+    data["api_key"] = config.apikey
     if file_elements is None:
         file_elements = {}
     # Using requests.post sets header 'Accept-encoding' automatically to
@@ -337,8 +338,8 @@ def __read_url(
     md5_checksum: str | None = None,
 ) -> requests.Response:
     data = {} if data is None else data
-    if config._config.apikey:
-        data["api_key"] = config._config.apikey
+    if config.apikey:
+        data["api_key"] = config.apikey
     return _send_request(
         request_method=request_method,
         url=url,
@@ -363,10 +364,10 @@ def _send_request(  # noqa: C901, PLR0912
     files: FILE_ELEMENTS_TYPE | None = None,
     md5_checksum: str | None = None,
 ) -> requests.Response:
-    n_retries = max(1, config._config.connection_n_retries)
+    n_retries = max(1, config.connection_n_retries)
 
     response: requests.Response | None = None
-    delay_method = _human_delay if config._config.retry_policy == "human" else _robot_delay
+    delay_method = _human_delay if config.retry_policy == "human" else _robot_delay
 
     # Error to raise in case of retrying too often. Will be set to the last observed exception.
     retry_raise_e: Exception | None = None