microsoft/FLAML

Documentation about small budget

Open

#748 opened on Oct 4, 2022

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Jupyter Notebook (560 forks)github user discovery
documentationgood first issue

Repository metrics

Stars
 (4,364 stars)
PR merge metrics
 (PR metrics pending)

Description

Thank you for your explaination @sonichi ! I now understand it. For small time budgets, It is advisable to rather use a predifined max_iter than a time_budget. @qingyun-wu : That is an interesting design question. I think returning a NoneType might break the code for some users. However, it is also a very special case that someone uses that little training time. Maybe a bit more explaination about that in the documentation might be helpful. For me a dummy regressor / classifier would make sense too, though. :)

Originally posted by @OliverSchacht in https://github.com/microsoft/FLAML/discussions/738#discussioncomment-3794757

Contributor guide

Research direction
Add a note in the documentation explaining that for small time budgets, it is better to set max iter instead of time budget, and mention the potential issue with NoneType return.
Tech stack
python
Domain
machine learning
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90