Apidocs (#692)

* Adding status_update to datasets api

* Adding assert_flows_equals to flows api

* Updating init for runs

* Adding run_exists for runs api

* Adding study and extensions api

* Adding OpenMLSetup and OpenMLParameter to top-level class docu

* Adding docstrings

* Debugging for missing documentation

* Adding class docstrings

* Addressing descriptor docstrings + adding Study object docstrings

* Updating PR template + Adding missing class from study to api

* Fixing typo in api.rst

* Changes to docstrings

* Removing BaseStudy from import

Author: Neeratyoy

PULL_REQUEST_TEMPLATE.md

@@ -6,6 +6,9 @@ Please make sure that:
 
 * this pull requests is against the `develop` branch
 * you updated all docs, this includes the changelog!
+* for any new function or class added, please add it to doc/api.rst
+    * the list of classes and functions should be alphabetical 
+* for any new functionality, consider adding a relevant example
 -->
 
 #### Reference Issue

doc/api.rst

@@ -13,12 +13,22 @@ Top-level Classes
    :toctree: generated/
    :template: class.rst
 
+   OpenMLBenchmarkSuite
+   OpenMLClassificationTask
+   OpenMLClusteringTask
+   OpenMLDataFeature
    OpenMLDataset
+   OpenMLEvaluation
+   OpenMLFlow
+   OpenMLLearningCurveTask
+   OpenMLParameter
+   OpenMLRegressionTask
    OpenMLRun
-   OpenMLTask
+   OpenMLSetup
    OpenMLSplit
-   OpenMLFlow
-   OpenMLEvaluation
+   OpenMLStudy
+   OpenMLSupervisedTask
+   OpenMLTask
 
 .. _api_extensions:
 
@@ -40,9 +50,10 @@ Extensions
    :toctree: generated/
    :template: function.rst
 
-    register_extension
-    get_extension_by_model
     get_extension_by_flow
+    get_extension_by_model
+    register_extension
+
 
 Modules
 -------
@@ -61,6 +72,7 @@ Modules
     get_dataset
     get_datasets
     list_datasets
+    status_update
 
 :mod:`openml.evaluations`: Evaluation Functions
 -----------------------------------------------
@@ -80,6 +92,7 @@ Modules
    :toctree: generated/
    :template: function.rst
 
+    assert_flows_equal
     flow_exists
     get_flow
     list_flows
@@ -100,6 +113,7 @@ Modules
     list_runs
     run_model_on_task
     run_flow_on_task
+    run_exists
 
 :mod:`openml.setups`: Setup Functions
 -------------------------------------
@@ -122,7 +136,20 @@ Modules
    :toctree: generated/
    :template: function.rst
 
-    get_study
+   attach_to_study
+   attach_to_suite
+   create_benchmark_suite
+   create_study
+   delete_study
+   delete_suite
+   detach_from_study
+   detach_from_suite
+   get_study
+   get_suite
+   list_studies
+   list_suites
+   update_study_status
+   update_suite_status
 
 :mod:`openml.tasks`: Task Functions
 -----------------------------------

openml/__init__.py

@@ -37,10 +37,11 @@
 from .runs import OpenMLRun
 from . import flows
 from .flows import OpenMLFlow
-from . import setups
 from . import study
-from .study import OpenMLStudy
+from .study import OpenMLStudy, OpenMLBenchmarkSuite
 from . import utils
+from . import setups
+from .setups import OpenMLSetup, OpenMLParameter
 
 
 from .__version__ import __version__
@@ -89,6 +90,7 @@ def populate_cache(task_ids=None, dataset_ids=None, flow_ids=None,
     'OpenMLSplit',
     'OpenMLEvaluation',
     'OpenMLSetup',
+    'OpenMLParameter',
     'OpenMLTask',
     'OpenMLSupervisedTask',
     'OpenMLClusteringTask',
@@ -97,6 +99,7 @@ def populate_cache(task_ids=None, dataset_ids=None, flow_ids=None,
     'OpenMLClassificationTask',
     'OpenMLFlow',
     'OpenMLStudy',
+    'OpenMLBenchmarkSuite',
     'datasets',
     'evaluations',
     'exceptions',

openml/datasets/functions.py

@@ -440,7 +440,8 @@ def get_dataset(
     Returns
     -------
     dataset : :class:`openml.OpenMLDataset`
-        The downloaded dataset."""
+        The downloaded dataset.
+    """
     if isinstance(dataset_id, str):
         try:
             dataset_id = int(dataset_id)

openml/runs/__init__.py

@@ -7,6 +7,7 @@
     list_runs,
     get_runs,
     get_run_trace,
+    run_exists,
     initialize_model_from_run,
     initialize_model_from_trace,
 )
@@ -21,6 +22,7 @@
     'list_runs',
     'get_runs',
     'get_run_trace',
+    'run_exists',
     'initialize_model_from_run',
     'initialize_model_from_trace'
 ]

openml/runs/functions.py

@@ -772,7 +772,7 @@ def list_runs(
     offset: Optional[int] = None,
     size: Optional[int] = None,
     id: Optional[List] = None,
-    task: Optional[List] = None,
+    task: Optional[List[int]] = None,
     setup: Optional[List] = None,
     flow: Optional[List] = None,
     uploader: Optional[List] = None,

openml/runs/run.py

@@ -25,10 +25,14 @@
 class OpenMLRun(object):
     """OpenML Run: result of running a model on an openml dataset.
 
-    Parameters
-    ----------
-    FIXME
-
+       Parameters
+       ----------
+       task_id : int
+           Refers to the task.
+       flow_id : int
+           Refers to the flow.
+       dataset_id: int
+           Refers to the data.
     """
 
     def __init__(self, task_id, flow_id, dataset_id, setup_string=None,

openml/setups/setup.py

@@ -10,7 +10,7 @@ class OpenMLSetup(object):
             The flow that it is build upon
         parameters : dict
             The setting of the parameters
-           """
+    """
 
     def __init__(self, setup_id, flow_id, parameters):
         if not isinstance(setup_id, int):