Skip to content

Commit 101e9a1

Browse files
committed
update docs a bit more
1 parent 6f50aae commit 101e9a1

3 files changed

Lines changed: 9 additions & 72 deletions

File tree

doc/conf.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,7 @@
7171
# General information about the project.
7272
project = u'OpenML'
7373
copyright = (
74-
u'2014-2018, Matthias Feurer, Andreas Müller, Farzan Majdani, '
75-
u'Joaquin Vanschoren, Jan van Rijn, Arlind Kadra and Pieter Gijsbers'
74+
u'2014-2019, the OpenML-Python team.'
7675
)
7776

7877
# The version info for the project you're documenting, acts as replacement for

doc/index.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,15 @@ You can install the OpenML package via `pip`:
5555
For more advanced installation information, please see the
5656
:ref:`installation` section.
5757

58-
-----
59-
Usage
60-
-----
58+
-------
59+
Content
60+
-------
6161

6262
* :ref:`usage`
6363
* :ref:`api`
64+
* `Examples <examples/index.html>`_
6465
* :ref:`contributing`
66+
* :ref:`progress`
6567

6668
-------------------
6769
Further information

doc/progress.rst

Lines changed: 3 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,7 @@
22

33
.. _progress:
44

5-
========
6-
Progress
7-
========
8-
5+
=========
96
Changelog
107
=========
118

@@ -66,72 +63,11 @@ There is no changelog for these versions.
6663
0.3.0
6764
~~~~~
6865

69-
* Add this changelog (Matthias Feurer)
70-
* 2nd example notebook PyOpenML.ipynb (Joaquin Vanschoren)
66+
* Add this changelog
67+
* 2nd example notebook PyOpenML.ipynb
7168
* Pagination support for list datasets and list tasks
7269

7370
Prior
7471
~~~~~
7572

7673
There is no changelog for prior versions.
77-
78-
API calls
79-
=========
80-
81-
=============================================== =========== ====== =============== ========== =====================
82-
API call implemented tested properly tested loads json proper error handling
83-
=============================================== =========== ====== =============== ========== =====================
84-
/data/{id} yes yes
85-
/data/features/{id} yes yes
86-
/data/qualities/{id} yes yes
87-
/data/list/ yes yes
88-
/data/list/tag/{tag} yes yes
89-
/data/upload/ yes yes
90-
/data/tag
91-
/data/untag
92-
/data/delete/ X
93-
94-
/task/{task} yes yes
95-
/task/list yes yes
96-
/task/list/type/{id} yes yes
97-
/task/list/tag/{tag} yes yes
98-
/task {POST}
99-
/task/tag
100-
/task/untag
101-
/task/delete X
102-
103-
/tasktype/{id}
104-
/tasktype/list
105-
106-
/flow/{id}
107-
/flow/exists/{name}/{ext_version} yes
108-
/flow/list yes
109-
/flow/list/tag/{tag}
110-
/flow/owned
111-
/flow/ {POST} yes yes
112-
/flow/tag
113-
/flow/untag
114-
/flow/{id} {DELETE} X
115-
116-
/run/list/task/{ids} yes yes
117-
/run/list/run/{ids} yes yes
118-
/run/list/tag/{tag} yes yes
119-
/run/{id} yes yes
120-
/run/list/uploader/{ids} yes yes
121-
/run/list/flow/{ids} yes yes
122-
/run/list/{filters} yes yes
123-
/run/untag
124-
/run (POST) yes yes
125-
/run/tag
126-
/run/{id} (DELETE) X
127-
128-
/evaluation/list/run/{ids}
129-
/evaluation/list/tag/{tag}
130-
/evaluation/list/task/{ids}
131-
/evaluation/list/uploader/{ids}
132-
/evaluation/list/flow/{ids}
133-
/evaluation/list/{filters}
134-
135-
=============================================== =========== ====== =============== ========== =====================
136-
137-
We do not plan to implement API calls marked with an **X**!

0 commit comments

Comments
 (0)