Documentation Update

[ArlindKadra]

openml-python/openml/runs/run.py

Lines 28 to 63 in 6e8a9db

	"""OpenML Run: result of running a model on an openml dataset.
	Parameters
	----------
	task_id: int
	flow_id: int
	dataset_id: int
	setup_string: str
	output_files: Dict[str, str]
	A dictionary that specifies where each related file can be found.
	setup_id: int
	tags: List[str]
	uploader: int
	User ID of the uploader.
	uploader_name: str
	evaluations: Dict
	fold_evaluations: Dict
	sample_evaluations: Dict
	data_content: List[List]
	The predictions generated from executing this run.
	trace: OpenMLRunTrace
	model: object
	task_type: str
	task_evaluation_measure: str
	flow_name: str
	parameter_settings: List[OrderedDict]
	predictions_url: str
	task: OpenMLTask
	flow: OpenMLFlow
	run_id: int
	description_text: str, optional
	Description text to add to the predictions file.
	If left None, is set to the time the arff file is generated.
	run_details: str, optional (default=None)
	Description of the run stored in the run meta-data.
	"""

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

[v-parmar]

Hey, What should you want to update?

[PGijsbers]

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]

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

[PGijsbers]

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]

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

[mfeurer]

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