Skip to main content

A fast library for automated machine learning and tuning

Project description

PyPI version Conda version Build Python Version Downloads

A Fast Library for Automated Machine Learning & Tuning


:fire: v1.2.0 is released with support for ChatGPT and GPT-4.

:fire: A lab forum on FLAML at AAAI 2023.

:fire: A hands-on tutorial on FLAML presented at KDD 2022

What is FLAML

FLAML is a lightweight Python library that finds accurate machine learning models automatically, efficiently and economically. It frees users from selecting models and hyperparameters for each model. It can also be used to tune generic hyperparameters for foundation models, MLOps/LMOps workflows, pipelines, mathematical/statistical models, algorithms, computing experiments, software configurations and so on.

  1. For common machine learning or AI tasks like classification, regression, and generation, it quickly finds quality models for user-provided data with low computational resources. It supports both classical machine learning models and deep neural networks, including foundation models such as the GPT series.
  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 model selection method invented by Microsoft Research, and many followup research studies.

FLAML has a .NET implementation in ML.NET, an open-source, cross-platform machine learning framework for .NET. In ML.NET, you can use FLAML via low-code solutions like Model Builder Visual Studio extension and the cross-platform ML.NET CLI. Alternatively, you can use the ML.NET AutoML API for a code-first experience.

Installation

Python

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

pip install flaml

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

pip install flaml[notebook]

.NET

Use the following guides to get started with FLAML in .NET:

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)
  • (New) You can optimize generations by ChatGPT or GPT-4 etc. with your own tuning data, success metrics and budgets.
from flaml import oai

config, analysis = oai.Completion.tune(
    data=tune_data,
    metric="success",
    mode="max",
    eval_func=eval_func,
    inference_budget=0.05,
    optimization_budget=3,
    num_samples=-1,
)

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:

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.2.2.tar.gz (228.5 kB view details)

Uploaded Source

Built Distribution

FLAML-1.2.2-py3-none-any.whl (251.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: FLAML-1.2.2.tar.gz
  • Upload date:
  • Size: 228.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.16

File hashes

Hashes for FLAML-1.2.2.tar.gz
Algorithm Hash digest
SHA256 9feeb7d17efc1644c9a8564c75b982fbc457141146d22ec893cdfc3a340731a1
MD5 e54e630a94403bd21d3e3c395d284383
BLAKE2b-256 0f36f3d9eb79762f93f168b0d552c7b9ddca5d551df52e937c79b8bfd752b48b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: FLAML-1.2.2-py3-none-any.whl
  • Upload date:
  • Size: 251.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.16

File hashes

Hashes for FLAML-1.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 cb0abdf25750298636e5f421e2ed28778346093ae19854d1746539094e43d215
MD5 956978adfd13209f9c6c6e7a350a28a1
BLAKE2b-256 2d13db603f8fd8b279525e7bfc30fbeab20178cc230d8b380e964d36b57f304e

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