Apidocs

[Neeratyoy]

What does this PR implement/fix? Explain your changes.

• Adds missing classes and functions to the API docs
• Adds missing docstrings for classes and functions featuring in the API
• Handles the case of missing docstrings for functions wrapped by decorators
• Edits the Pull Request template instruction, asking for new functions/classes to be included alphabetically in api.rst

How should this PR be tested?

• Viewing the api page

Any other comments?

• For some functions/classes the docstrings are placeholders and can be much improved.

[joaquinvanschoren]

Hi Neeratyoy, Matthias, seems like the unit tests broke because of the release of scipy 1.3.0:
https://github.com/scipy/scipy/releases

which adds this:

For the Attribute-Relation File Format (ARFF) scipy.io.arff.loadarff
now supports relational attributes.

and breaks this:
https://travis-ci.org/openml/openml-python/jobs/534987620#L1420

Is this easy to fix, or shall we update the dependencies to: scipy>0.13.3,<1.3.0?

openml-python/setup.py

Line 45 in 4152f91

'scipy>=0.13.3',

[mfeurer]

@joaquinvanschoren thanks for having a look at this. I'd actually prefer to use liac-arff for this instead. First, it's much faster now since Joel Nothman from the sklearn team improved it, and second, we'd use the same arff reader in all places. However, I suggest that we use a different PR for that. @Neeratyoy could you please put that on your todo list?

[Neeratyoy]

@mfeurer alright I shall look into this first.

[mfeurer]

Please do not make BaseStudy available to the user here.

[Neeratyoy]

Removed.
Pushed the changes.

[mfeurer]

Sorry, but this one is still there.

[Neeratyoy]

Yes, sorry my mistake. Just noticed. Pushed the changes.

[mfeurer]

Seing this I'm surprised that we allow strings here and cast them to int inside the constructor. Could you please update the code so that:

1. the casting happens outside
2. the docstring reflects this
3. the type annotation reflects this, too

[Neeratyoy]

By casting outside, are you referring to an explicit cast made by the user or in any function invoking the constructor? Just checked some other constructors, and they accept ids only as int.
Shall I make the id parameters take only int here too?

[mfeurer]

I mean 'any function invoking the constructor'. Yes, it would be good to only accepts integers here, too.