Skip to content

Use name instead of interger ids #1063

Closed

Description

@ArlindKadra

Description

Use names instead of integer ids when possible for better readability (e.g., for datasets at least it is possible to use names of the dataset).

Activity

  1. self-assigned this
    on Apr 26, 2021
  2. PGijsbers commented on Apr 28, 2021

    @PGijsbers
    Collaborator

    Should we consider stating the id in the tutorial text/comments? That way if the dataset is not correctly found by name (e.g. because a newer version is uploaded which breaks the example), users can refer to the id?

  3. ArlindKadra commented on Apr 28, 2021

    @ArlindKadra
    MemberAuthor

    Hey @PGijsbers, I had the same thought and I fully agree with it. I will do that too.

  4. ArlindKadra commented on Apr 28, 2021

    @ArlindKadra
    MemberAuthor
        If dataset is retrieved by name, a version may be specified.
        If no version is specified and multiple versions of the dataset exist,
        the earliest version of the dataset that is still active will be returned.
        If no version is specified, multiple versions of the dataset exist and
        ``exception_if_multiple`` is set to ``True``, this function will raise an exception.
    

    On another note, reading the documentation, I think we can put the dataset version in the function call, that should also work. We can even give the error_if_multiple its default value for users to understand that the function has quite a bit to offer.

  5. mfeurer commented on Apr 29, 2021

    @mfeurer
    Collaborator

    On another note, reading the documentation, I think we can put the dataset version in the function call, that should also work.

    Yes, that sounds like a good idea.

    We can even give the error_if_multiple its default value for users to understand that the function has quite a bit to offer.

    You could add that to the datasets example.

  6. added
    Good First IssueIssues suitable for people new to contributing to openml-python!
    on Jun 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

DocumentationGood First IssueIssues suitable for people new to contributing to openml-python!

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions