Skip to content

Documentation Update #1069

Closed
Closed
Documentation Update#1069
Labels
Documentationmodule:DataOpenML concept
Milestone
0.13.1

Description

@ArlindKadra
ArlindKadra
opened on May 3, 2021

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.
"""
See More

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

Activity

  1. ArlindKadra
    added
    Documentation
    on May 3, 2021
  2. PGijsbers
    added this to the 0.13.1 milestone on Nov 29, 2022

  3. v-parmar commented on Dec 26, 2022

    @v-parmar
    v-parmar
    on Dec 26, 2022
    Contributor

    Hey, What should you want to update?

  4. PGijsbers commented on Jan 2, 2023

    @PGijsbers
    PGijsbers
    on Jan 2, 2023
    Collaborator

    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.

  5. v-parmar commented on Jan 26, 2023

    @v-parmar
    v-parmar
    on Jan 26, 2023
    Contributor

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

  6. PGijsbers commented on Jan 30, 2023

    @PGijsbers
    PGijsbers
    on Jan 30, 2023
    Collaborator

    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

  7. v-parmar commented on Feb 20, 2023

    @v-parmar
    v-parmar
    on Feb 20, 2023
    Contributor

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

  8. mfeurer
    added
    module:DataOpenML concept
    on Feb 20, 2023

  9. mfeurer commented on Feb 24, 2023

    @mfeurer
    mfeurer
    on Feb 24, 2023
    Collaborator

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

  10. mfeurer
    closed this as completedon Feb 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Documentationmodule:DataOpenML concept

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions