Skip to content

Commit 5dcb7a3

Browse files
authored
Update run.py (#1194)
* Update run.py * Update run.py updated description to not contain duplicate information. * Update run.py
1 parent 5b2ac46 commit 5dcb7a3

File tree

1 file changed

+24
-5
lines changed

1 file changed

+24
-5
lines changed

openml/runs/run.py

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,36 +31,55 @@ class OpenMLRun(OpenMLBase):
3131
Parameters
3232
----------
3333
task_id: int
34+
The ID of the OpenML task associated with the run.
3435
flow_id: int
36+
The ID of the OpenML flow associated with the run.
3537
dataset_id: int
38+
The ID of the OpenML dataset used for the run.
3639
setup_string: str
40+
The setup string of the run.
3741
output_files: Dict[str, str]
38-
A dictionary that specifies where each related file can be found.
42+
Specifies where each related file can be found.
3943
setup_id: int
44+
An integer representing the ID of the setup used for the run.
4045
tags: List[str]
46+
Representing the tags associated with the run.
4147
uploader: int
42-
User ID of the uploader.
48+
User ID of the uploader.
4349
uploader_name: str
50+
The name of the person who uploaded the run.
4451
evaluations: Dict
52+
Representing the evaluations of the run.
4553
fold_evaluations: Dict
54+
The evaluations of the run for each fold.
4655
sample_evaluations: Dict
56+
The evaluations of the run for each sample.
4757
data_content: List[List]
4858
The predictions generated from executing this run.
4959
trace: OpenMLRunTrace
60+
The trace containing information on internal model evaluations of this run.
5061
model: object
62+
The untrained model that was evaluated in the run.
5163
task_type: str
64+
The type of the OpenML task associated with the run.
5265
task_evaluation_measure: str
66+
The evaluation measure used for the task.
5367
flow_name: str
68+
The name of the OpenML flow associated with the run.
5469
parameter_settings: List[OrderedDict]
70+
Representing the parameter settings used for the run.
5571
predictions_url: str
72+
The URL of the predictions file.
5673
task: OpenMLTask
74+
An instance of the OpenMLTask class, representing the OpenML task associated with the run.
5775
flow: OpenMLFlow
76+
An instance of the OpenMLFlow class, representing the OpenML flow associated with the run.
5877
run_id: int
78+
The ID of the run.
5979
description_text: str, optional
60-
Description text to add to the predictions file.
61-
If left None, is set to the time the arff file is generated.
80+
Description text to add to the predictions file. If left None, is set to the time the arff file is generated.
6281
run_details: str, optional (default=None)
63-
Description of the run stored in the run meta-data.
82+
Description of the run stored in the run meta-data.
6483
"""
6584

6685
def __init__(

0 commit comments

Comments
 (0)