Added notice to all examples for using the test server. Use test server in new way.

Author: PGijsbers

doc/conf.py

@@ -17,12 +17,6 @@
 import sphinx_bootstrap_theme
 import openml
 
-
-# amueller's read/write key
-openml.config.server = "https://test.openml.org/api/v1/xml"
-openml.config.apikey = "610344db6388d9ba34f6db45a3cf71de"
-
-
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.

examples/create_upload_tutorial.py

@@ -13,9 +13,12 @@
 from openml.datasets.functions import create_dataset
 
 ############################################################################
-# For this tutorial we will upload to the test server to not pollute the live
-# server with countless copies of the same dataset.
-openml.config.server = 'https://test.openml.org/api/v1/xml'
+# .. 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.
+
+openml.config.start_use_example_configuration()
+############################################################################
 
 ############################################################################
 # Below we will cover the following cases of the dataset object:
@@ -309,3 +312,7 @@
 
 upload_did = xor_dataset.publish()
 print('URL for dataset: %s/data/%d' % (openml.config.server, upload_did))
+
+
+############################################################################
+openml.config.stop_use_example_configuration()

examples/datasets_tutorial.py

@@ -6,6 +6,14 @@
 How to list and download datasets.
 """
 
+############################################################################
+# .. 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.
+
+openml.config.start_use_example_configuration()
+############################################################################
+
 import openml
 import pandas as pd
 
@@ -101,3 +109,7 @@
     alpha=.8,
     cmap='plasma'
 )
+
+
+############################################################################
+openml.config.stop_use_example_configuration()

examples/flows_and_runs_tutorial.py

@@ -14,7 +14,11 @@
 # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 #
 # Train a scikit-learn model on the data manually.
+# .. 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.
 
+openml.config.start_use_example_configuration()
 # NOTE: Dataset 68 exists on the test server https://test.openml.org/d/68
 dataset = openml.datasets.get_dataset(68)
 X, y = dataset.get_data(
@@ -159,3 +163,7 @@
     run = openml.runs.run_model_on_task(clf, task, avoid_duplicate_runs=False)
     myrun = run.publish()
     print("kNN on %s: http://test.openml.org/r/%d" % (data.name, myrun.run_id))
+
+
+############################################################################
+openml.config.stop_use_example_configuration()

examples/introduction_tutorial.py

@@ -45,12 +45,20 @@
 #   file must be in the directory ~/.openml/config and exist prior to
 #   importing the openml module.
 # * Run the code below, replacing 'YOURKEY' with your API key.
-
+# .. 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.
 ############################################################################
 import openml
 from sklearn import neighbors
 
-# Uncomment and set your OpenML key. Don't share your key with others.
+openml.config.start_use_example_configuration()
+
+############################################################################
+# When using the main server, instead make sure your apikey is configured.
+# This can be done with the following line of code (uncomment it!).
+# Never share your apikey with others.
+
 # openml.config.apikey = 'YOURKEY'
 
 ############################################################################
@@ -83,3 +91,6 @@
 # as to not pollute the main server.
 myrun = run.publish()
 print("kNN on %s: http://test.openml.org/r/%d" % (data.name, myrun.run_id))
+
+############################################################################
+openml.config.stop_use_example_configuration()

examples/run_setup_tutorial.py

@@ -25,6 +25,9 @@
        and solve the same task again;
     3) We will verify that the obtained results are exactly the same.
 
+.. 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.
 """
 import logging
 import numpy as np
@@ -36,6 +39,7 @@
 
 root = logging.getLogger()
 root.setLevel(logging.INFO)
+openml.config.start_use_example_configuration()
 
 ###############################################################################
 # 1) Create a flow and use it to solve a task
@@ -100,3 +104,7 @@
 # the run has stored all predictions in the field data content
 np.testing.assert_array_equal(run_original.data_content,
                               run_duplicate.data_content)
+
+###############################################################################
+
+openml.config.stop_use_example_configuration()

examples/sklearn/openml_run_example.py

@@ -7,6 +7,14 @@
 import openml
 from sklearn import tree, preprocessing, pipeline
 
+############################################################################
+# .. 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.
+
+openml.config.start_use_example_configuration()
+############################################################################
+
 # Uncomment and set your OpenML key. Don't share your key with others.
 # openml.config.apikey = 'YOURKEY'
 
@@ -27,3 +35,6 @@
 run.publish()
 
 print('URL for run: %s/run/%d' % (openml.config.server, run.run_id))
+
+############################################################################
+openml.config.stop_use_example_configuration()