Skip to main content

A fast library for automated machine learning and tuning

Project description

PyPI version Conda version Build Python Version Downloads Join the chat at https://gitter.im/FLAMLer/community

A Fast Library for Automated Machine Learning & Tuning


FLAML is a lightweight Python library that finds accurate machine learning models automatically, efficiently and economically. It frees users from selecting learners and hyperparameters for each learner.

  1. For common machine learning tasks like classification and regression, it quickly finds quality models for user-provided data with low computational resources. It supports both classifcal machine learning models and deep neural networks.
  2. It is easy to customize or extend. Users can find their desired customizability from a smooth range: minimal customization (computational resource budget), medium customization (e.g., scikit-style learner, search space and metric), or full customization (arbitrary training and evaluation code).
  3. It supports fast automatic tuning, capable of handling complex constraints/guidance/early stopping. FLAML is powered by a new, cost-effective hyperparameter optimization and learner selection method invented by Microsoft Research.

FLAML has a .NET implementation as well from ML.NET Model Builder in Visual Studio 2022. This ML.NET blog describes the improvement brought by FLAML.

Installation

FLAML requires Python version >= 3.6. It can be installed from pip:

pip install flaml

To run the notebook examples, install flaml with the [notebook] option:

pip install flaml[notebook]

Quickstart

from flaml import AutoML
automl = AutoML()
automl.fit(X_train, y_train, task="classification")
  • You can restrict the learners and use FLAML as a fast hyperparameter tuning tool for XGBoost, LightGBM, Random Forest etc. or a customized learner.
automl.fit(X_train, y_train, task="classification", estimator_list=["lgbm"])
from flaml import tune
tune.run(evaluation_function, config={}, low_cost_partial_config={}, time_budget_s=3600)
  • Zero-shot AutoML allows using the existing training API from lightgbm, xgboost etc. while getting the benefit of AutoML in choosing high-performance hyperparameter configurations per task.
from flaml.default import LGBMRegressor
# Use LGBMRegressor in the same way as you use lightgbm.LGBMRegressor.
estimator = LGBMRegressor()
# The hyperparameters are automatically set according to the training data.
estimator.fit(X_train, y_train)

Documentation

You can find a detailed documentation about FLAML here where you can find the API documentation, use cases and examples.

In addition, you can find:

  • Demo and tutorials of FLAML here.

  • Research around FLAML here.

  • FAQ here.

  • Contributing guide here.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

If you are new to GitHub here is a detailed help source on getting involved with development on GitHub.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

FLAML-1.0.0.tar.gz (147.3 kB view details)

Uploaded Source

Built Distribution

FLAML-1.0.0-py3-none-any.whl (157.2 kB view details)

Uploaded Python 3

File details

Details for the file FLAML-1.0.0.tar.gz.

File metadata

  • Download URL: FLAML-1.0.0.tar.gz
  • Upload date:
  • Size: 147.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.13

File hashes

Hashes for FLAML-1.0.0.tar.gz
Algorithm Hash digest
SHA256 ea30b3bf613e6816017aadbdf9edb2674cdd0556cddc815d00e482e4290c45f4
MD5 4164e548c62aee16dabac7927b0b568b
BLAKE2b-256 076dd7fa537ed8b369b6470b615c468733068fe12d14210929a86e267fbd8117

See more details on using hashes here.

File details

Details for the file FLAML-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: FLAML-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 157.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.13

File hashes

Hashes for FLAML-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 179858383abb6c8d72bc46622851794971912648e73beb78cae68de192e685d4
MD5 48c9ba6e98912365ef49644e6e2eb982
BLAKE2b-256 8f5293baf7588c6e1b333cd7f9a45ed2621cd189ce9215bd4acd5ec1c6666b01

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page