Documentation Update - Githubissues

openml / openml-python

OpenML's Python API for a World of Data and More 💫

http://openml.github.io/openml-python/

Other

279 stars 143 forks source link

Documentation Update #1069

Closed ArlindKadra closed 1 year ago

ArlindKadra commented 3 years ago

https://github.com/openml/openml-python/blob/6e8a9db03fd1af9d3eb0623970101413b531cc69/openml/runs/run.py#L28-L63

This probably we should update, considering there are some fields that do not have a description and might be clearer with one.

v-parmar commented 1 year ago

Hey, What should you want to update?

PGijsbers commented 1 year ago

For each attribute we would want a description of what it represents, e.g.:

     trace: OpenMLRunTrace 
+     The trace containing information on internal model evaluations of this run.
     model: object 
+     The untrained model that was evaluated in this run.

v-parmar commented 1 year ago

Hey, I have done the given task. How can I submit it?

PGijsbers commented 1 year ago

We documented the process in our contribution guidelines, in short:

push to your fork
check that it meets all the criteria to open a pull request (optionally add things if it doesn't)
set up a pull request and wait for review

v-parmar commented 1 year ago

Hey @PGijsbers, I have opened the PR on issue #1069 and added the description please check it(#1194).

mfeurer commented 1 year ago

This was solved by @v-parmar via #1194.