Adding warnings to all examples switching to a test server

openml · mfeurer · Apr 29, 2021 · Apr 21, 2021 · Apr 22, 2021 · Apr 22, 2021
commit 1b172c676b7d2a69a6bbaec904d8d88586a46f60
diff --git a/examples/20_basic/introduction_tutorial.py b/examples/20_basic/introduction_tutorial.py
@@ -53,10 +53,7 @@
 #
 # Alternatively, by running the code below and replacing 'YOURKEY' with your API key,
 # you authenticate for the duration of the python process.
-#
-# .. warning:: This example uploads data. For that reason, this example
-#   connects to the test server instead. This prevents the live server from
-#   crowding with example datasets, tasks, studies, and so on.
+
 
 ############################################################################
 
@@ -65,6 +62,12 @@
 import openml
 from sklearn import neighbors
 
+############################################################################
+# .. warning:: This example uploads data. For that reason, this example
+#   connects to the test server at test.openml.org. This prevents the main
+#   server from crowding with example datasets, tasks, runs, and so on. The
+#   use of this test server can affect behaviour and performance of the
+#   OpenML-Python API.
 openml.config.start_using_configuration_for_example()
 
 ############################################################################

diff --git a/examples/20_basic/simple_flows_and_runs_tutorial.py b/examples/20_basic/simple_flows_and_runs_tutorial.py
@@ -16,7 +16,9 @@
 #
 # .. warning:: This example uploads data. For that reason, this example
 #   connects to the test server at test.openml.org. This prevents the main
-#   server from crowding with example datasets, tasks, runs, and so on.
+#   server from crowding with example datasets, tasks, runs, and so on. The
+#   use of this test server can affect behaviour and performance of the
+#   OpenML-Python API.
 
 openml.config.start_using_configuration_for_example()
 

diff --git a/examples/30_extended/create_upload_tutorial.py b/examples/30_extended/create_upload_tutorial.py
@@ -18,7 +18,9 @@
 ############################################################################
 # .. warning:: This example uploads data. For that reason, this example
 #   connects to the test server at test.openml.org. This prevents the main
-#   server from crowding with example datasets, tasks, runs, and so on.
+#   server from crowding with example datasets, tasks, runs, and so on. The
+#   use of this test server can affect behaviour and performance of the
+#   OpenML-Python API.
 
 openml.config.start_using_configuration_for_example()
 ############################################################################

diff --git a/examples/30_extended/custom_flow_.py b/examples/30_extended/custom_flow_.py
@@ -13,19 +13,21 @@
 and also show how to link runs to the custom flow.
 """
 
-####################################################################################################
-
 # License: BSD 3-Clause
-# .. warning:: This example uploads data. For that reason, this example
-#   connects to the test server at test.openml.org. This prevents the main
-#   server from crowding with example datasets, tasks, runs, and so on.
+
 from collections import OrderedDict
 import numpy as np
 
 import openml
 from openml import OpenMLClassificationTask
 from openml.runs.functions import format_prediction
 
+####################################################################################################
+# .. warning:: This example uploads data. For that reason, this example
+#   connects to the test server at test.openml.org. This prevents the main
+#   server from crowding with example datasets, tasks, runs, and so on. The
+#   use of this test server can affect behaviour and performance of the
+#   OpenML-Python API.
 openml.config.start_using_configuration_for_example()
 
 ####################################################################################################

diff --git a/examples/30_extended/datasets_tutorial.py b/examples/30_extended/datasets_tutorial.py
@@ -114,6 +114,12 @@
 # Edit a created dataset
 # ======================
 # This example uses the test server, to avoid editing a dataset on the main server.
+#
+# .. warning:: This example uploads data. For that reason, this example
+#   connects to the test server at test.openml.org. This prevents the main
+#   server from crowding with example datasets, tasks, runs, and so on. The
+#   use of this test server can affect behaviour and performance of the
+#   OpenML-Python API.
 openml.config.start_using_configuration_for_example()
 ############################################################################
 # Edit non-critical fields, allowed for all authorized users:

diff --git a/examples/30_extended/flow_id_tutorial.py b/examples/30_extended/flow_id_tutorial.py
@@ -16,7 +16,14 @@
 import openml
 
 
+############################################################################
 # Activating test server
+#
+# .. warning:: This example uploads data. For that reason, this example
+#   connects to the test server at test.openml.org. This prevents the main
+#   server from crowding with example datasets, tasks, runs, and so on. The
+#   use of this test server can affect behaviour and performance of the
+#   OpenML-Python API.
 openml.config.start_using_configuration_for_example()
 
 

diff --git a/examples/30_extended/flows_and_runs_tutorial.py b/examples/30_extended/flows_and_runs_tutorial.py
@@ -18,7 +18,9 @@
 #
 # .. warning:: This example uploads data. For that reason, this example
 #   connects to the test server at test.openml.org. This prevents the main
-#   server from crowding with example datasets, tasks, runs, and so on.
+#   server from crowding with example datasets, tasks, runs, and so on. The
+#   use of this test server can affect behaviour and performance of the
+#   OpenML-Python API.
 
 openml.config.start_using_configuration_for_example()
 # NOTE: We are using dataset 68 from the test server: https://test.openml.org/d/68

diff --git a/examples/30_extended/run_setup_tutorial.py b/examples/30_extended/run_setup_tutorial.py
@@ -43,7 +43,12 @@
 from sklearn.ensemble import RandomForestClassifier
 from sklearn.decomposition import TruncatedSVD
 
-
+############################################################################
+# .. warning:: This example uploads data. For that reason, this example
+#   connects to the test server at test.openml.org. This prevents the main
+#   server from crowding with example datasets, tasks, runs, and so on. The
+#   use of this test server can affect behaviour and performance of the
+#   OpenML-Python API.
 openml.config.start_using_configuration_for_example()
 
 ###############################################################################

diff --git a/examples/30_extended/study_tutorial.py b/examples/30_extended/study_tutorial.py
@@ -73,6 +73,13 @@
 # Creating a study is as simple as creating any kind of other OpenML entity.
 # In this examples we'll create a few runs for the OpenML-100 benchmark
 # suite which is available on the OpenML test server.
+#
+# .. warning:: This example uploads data. For that reason, this example
+#   connects to the test server at test.openml.org. This prevents the main
+#   server from crowding with example datasets, tasks, runs, and so on. The
+#   use of this test server can affect behaviour and performance of the
+#   OpenML-Python API.
+
 openml.config.start_using_configuration_for_example()
 
 # Model to be used

diff --git a/examples/30_extended/suites_tutorial.py b/examples/30_extended/suites_tutorial.py
@@ -73,6 +73,12 @@
 # Uploading suites is as simple as uploading any kind of other OpenML
 # entity - the only reason why we need so much code in this example is
 # because we upload some random data.
+#
+# .. warning:: This example uploads data. For that reason, this example
+#   connects to the test server at test.openml.org. This prevents the main
+#   server from crowding with example datasets, tasks, runs, and so on. The
+#   use of this test server can affect behaviour and performance of the
+#   OpenML-Python API.
 
 openml.config.start_using_configuration_for_example()
 

diff --git a/examples/30_extended/tasks_tutorial.py b/examples/30_extended/tasks_tutorial.py
@@ -183,7 +183,12 @@
 # If a task with these parameters exists, we will get an appropriate exception.
 # If such a task doesn't exist, a task will be created and the corresponding task_id
 # will be returned.
-
+#
+# .. warning:: This example uploads data. For that reason, this example
+#   connects to the test server at test.openml.org. This prevents the main
+#   server from crowding with example datasets, tasks, runs, and so on. The
+#   use of this test server can affect behaviour and performance of the
+#   OpenML-Python API.
 
 # using test server for example uploads
 openml.config.start_using_configuration_for_example()