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: FLAML is highlighted in OpenAI's cookbook :fire: autogen is released with support for ChatGPT and GPT-4, based on Cost-Effective Hyperparameter Optimization for Large Language Model Generation Inference. :fire: FLAML supports AutoML and Hyperparameter Tuning features in Microsoft Fabric private preview. Sign up for these features at: https://aka.ms/fabric/data-science/sign-up.

What is FLAML

FLAML is a lightweight Python library for efficient automation of machine learning and AI operations, including selection of models, hyperparameters, and other tunable choices of an application (e.g., inference hyperparameters for foundation models, configurations in MLOps/LMOps workflows, pipelines, mathematical/statistical models, algorithms, computing experiments, software configurations).

  • For foundation models like the GPT models, it automates the experimentation and optimization of their performance to maximize the effectiveness for applications and minimize the inference cost. FLAML enables users to build and use adaptive AI agents with minimal effort.
  • For common machine learning tasks like classification and regression, it quickly finds quality models for user-provided data with low computational resources. 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., search space and metric), or full customization (arbitrary training/inference/evaluation code).
  • It supports fast and economical automatic tuning, capable of handling complex constraints/guidance/early stopping. FLAML is powered by a 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

Minimal dependencies are installed without extra options. You can install extra options based on the feature you need. For example, use the following to install the dependencies needed by the autogen package.

pip install "flaml[autogen]"

Find more options in Installation. Each of the notebook examples may require a specific option to be installed.

.NET

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

Quickstart

  • (New) The autogen package can help you maximize the utility out of the expensive LLMs such as ChatGPT and GPT-4, including:
    • A drop-in replacement of openai.Completion or openai.ChatCompletion with powerful functionalites like tuning, caching, templating, filtering. For example, you can optimize generations by LLM with your own tuning data, success metrics and budgets.
    from flaml import oai
    
    # perform tuning
    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,
    )
    
    # perform inference for a test instance
    response = oai.Completion.create(context=test_instance, **config)
    
    • LLM-driven intelligent agents which can perform tasks autonomously or with human feedback, including tasks that require using tools via code.
    assistant = AssistantAgent("assistant")
    user = UserProxyAgent("user", human_input_mode="TERMINATE")
    assistant.receive("Draw a rocket and save to a file named 'rocket.svg'")
    
  • With three lines of code, you can start using this economical and fast AutoML engine as a scikit-learn style estimator.
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:

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-2.0.0rc1.tar.gz (238.1 kB view details)

Uploaded Source

Built Distribution

FLAML-2.0.0rc1-py3-none-any.whl (262.1 kB view details)

Uploaded Python 3

File details

Details for the file FLAML-2.0.0rc1.tar.gz.

File metadata

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

File hashes

Hashes for FLAML-2.0.0rc1.tar.gz
Algorithm Hash digest
SHA256 883c63b804f535eb3c7a266271b964719fb264de2017020def3c0e4cde8235f0
MD5 2253b8152cc9e2fe37a5b0c56c73f599
BLAKE2b-256 d0e2a5fc4ab37e88472351255c69fe1a4f1f403f05ecb5194266281a9b34289b

See more details on using hashes here.

File details

Details for the file FLAML-2.0.0rc1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for FLAML-2.0.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 129338cf070df7716eb9e8045ada975632f13daad4b53f9e51b4251b606d2ba1
MD5 48bf283c5f704e23b3e93345f2c54ec1
BLAKE2b-256 652fc46c1833034a9a005e433efa9a1dbf01f4656320c28a22d6f354e80b8c96

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