Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for automl.model.estimator usage #1311

Merged
merged 7 commits into from
Oct 31, 2024

Conversation

Programmer-RD-AI
Copy link
Contributor

@Programmer-RD-AI Programmer-RD-AI commented May 28, 2024

Updated documentation across various examples and the model.py file to include information about automl.model.estimator. This addition addresses issue #1194 and enhances the clarity and usability of FLAML by providing users with clear guidance on how to utilize this feature in their AutoML workflows. By documenting automl.model.estimator, users can better understand FLAML's capabilities and improve their overall experience with the library.

Why are these changes needed?

These changes are necessary to address user feedback and improve the usability of FLAML. The addition of documentation for automl.model.estimator helps users understand how to access and utilize this feature effectively, thus enhancing their experience with the library.

Related issue number

Checks

  • I've included any doc changes needed for https://microsoft.github.io/FLAML/.
  • I've added tests (if relevant) corresponding to the changes introduced in this PR.
  • I've made sure all auto checks have passed.

Programmer-RD-AI and others added 2 commits May 28, 2024 12:20
Updated documentation across various examples and the model.py file to include information about automl.model.estimator. This addition enhances the clarity and usability of FLAML by providing users with clear guidance on how to utilize this feature in their AutoML workflows. These changes aim to improve the overall user experience and facilitate easier understanding of FLAML's capabilities.
@thinkall
Copy link
Collaborator

Hi @Programmer-RD-AI , thank you for the PR. Could you fix the code formatting error with pre-commit? Thanks.

@thinkall thinkall added need more info Can't address without more information question Further information is requested and removed need more info Can't address without more information labels Aug 6, 2024
@dannycg1996
Copy link
Collaborator

Hi @thinkall - not sure what the rules are on this.
Can I have maintainer access please? Would happily find PRs like this, which are just a pre-commit hook short of being mergeable, and run the pre-commit hook.

@thinkall
Copy link
Collaborator

Hi @thinkall - not sure what the rules are on this. Can I have maintainer access please? Would happily find PRs like this, which are just a pre-commit hook short of being mergeable, and run the pre-commit hook.

Thank you @dannycg1996 , added you as a maintainer.
Here is the doc for pre-commit: https://microsoft.github.io/FLAML/docs/Contribute#pre-commit .

@dannycg1996
Copy link
Collaborator

Thanks @thinkall!
I think this should be mergeable once the tests pass.

Copy link
Collaborator

@thinkall thinkall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thinkall thinkall merged commit 7644958 into microsoft:main Oct 31, 2024
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document about automl.model.estimator
3 participants