Skip to content

Extract parameter and model description from scikit-learn docstrings #175

Closed

Description

@mfeurer

and store in the description of the flow or the description of the parameters.

Activity

  1. PGijsbers commented on Apr 4, 2018

    @PGijsbers
    Collaborator

    Comment for reference of whoever is interested in picking up this issue.

    As far as I can tell this is not resolved yet, but most work has been done (?).
    Parameter meta information can be passed to OpenMLFlow, so I think the goal is to pass this information correctly when creating a flow from a sklearn model. To me it looks like the right place to start this is here.

  2. added
    Good First IssueIssues suitable for people new to contributing to openml-python!
    on Jan 15, 2019
  3. self-assigned this
    on Jul 24, 2019
  4. Neeratyoy commented on Jul 25, 2019

    @Neeratyoy
    Contributor

    @mfeurer it seems that if the str length of a flow description is > 1024, we get an OpenMLServerException: Problem validating uploaded description file
    Is that expected?

    Steps to recreate:
    task = openml.tasks.get_task(403)
    clf = sklearn.linear_model.SGDClassifier()
    r, f = openml.runs.run_model_on_task(clf, task, return_flow=True)
    dummy_str = '-' * 1024
    f.description = dummy_str
    f = f.publish() # this works
    openml.utils._delete_entity('flow', f.flow_id)
    f.flow_id = None
    dummy_str = '-' * 1025
    f.description = dummy_str
    f = f.publish() # this does not work

    Now w.r.t. this feature request, will not the flow description become excessively large given that sklearn has a good 2-3 line description for each parameter (roughly on an average). This would also entail changing the __repr__ for OpenMLFlow.

    What do you suggest?

  5. mfeurer commented on Jul 26, 2019

    @mfeurer
    CollaboratorAuthor

    Is that expected?
    Unfortunately, yes.

    I'd suggest to store the first 1024 characters of the docstring on OpenML (but always stopping before the "Read more here" or "Parameters"). I don't see a real issue with repr for now. We can change that if this becomes a real issue for users?

  6. mfeurer commented on Sep 13, 2019

    @mfeurer
    CollaboratorAuthor

    Added via #756

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Feature requestGood 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