安装 AutoGluon

注意

我们建议大多数用户通过 pip 进行安装。通过 pip 安装 AutoGluon 是我们积极进行基准测试和测试的版本。通过 Conda 安装可能在依赖项方面存在细微差异，这可能会影响性能和稳定性，如果您在使用 Conda 时遇到问题，我们建议尝试 pip。

pip install -U pip
pip install -U setuptools wheel
pip install autogluon --extra-index-url https://download.pytorch.org/whl/cpu

pip install -U pip
pip install -U setuptools wheel
pip install autogluon

# Install UV package installer (faster than pip)
pip install -U uv

# Install AutoGluon
python -m uv pip install autogluon --extra-index-url https://download.pytorch.org/whl/cpu

# Install UV package installer (faster than pip)
pip install -U uv

# Install AutoGluon with GPU support
python -m uv pip install autogluon

conda create -n ag python=3.10
conda activate ag
conda install -c conda-forge mamba
mamba install -c conda-forge autogluon
mamba install -c conda-forge "ray-tune >=2.10.0,<2.32" "ray-default >=2.10.0,<2.32"  # install ray for faster training

conda create -n ag python=3.11
conda activate ag
conda install -c conda-forge mamba
mamba install -c conda-forge autogluon "pytorch=*=cuda*"
mamba install -c conda-forge "ray-tune >=2.10.0,<2.32" "ray-default >=2.10.0,<2.32"  # install ray for faster training

pip install uv
python -m uv pip install -U torch torchvision --extra-index-url https://download.pytorch.org/whl/cpu
git clone https://github.com/autogluon/autogluon
cd autogluon && ./full_install.sh

git clone https://github.com/autogluon/autogluon
cd autogluon && ./full_install.sh

MacOS 上的 LightGBM 支持 (LibOMP)

AutoGluon 的依赖项 LightGBM 使用 libomp 进行多线程处理。如果您通过 brew install libomp 安装 libomp，可能会因库版本不兼容而遇到段错误。请使用以下命令安装兼容版本

# Uninstall libomp if it was previous installed
brew uninstall -f libomp
wget https://raw.githubusercontent.com/Homebrew/homebrew-core/fb8323f2b170bd4ae97e1bac9bf3e2983af3fdb0/Formula/libomp.rb
brew install libomp.rb
rm libomp.rb

pip install -U pip
pip install -U setuptools wheel

pip install autogluon --extra-index-url https://download.pytorch.org/whl/cpu

警告

macOS 尚不支持 GPU 使用，请使用 Linux 或 Windows 在 AutoGluon 中利用 GPU。

MacOS 上的 LightGBM 支持 (LibOMP)

AutoGluon 的依赖项 LightGBM 使用 libomp 进行多线程处理。如果您通过 brew install libomp 安装 libomp，可能会因库版本不兼容而遇到段错误。请使用以下命令安装兼容版本

# Uninstall libomp if it was previous installed
brew uninstall -f libomp
wget https://raw.githubusercontent.com/Homebrew/homebrew-core/fb8323f2b170bd4ae97e1bac9bf3e2983af3fdb0/Formula/libomp.rb
brew install libomp.rb
rm libomp.rb

# Install UV package installer (faster than pip)
pip install -U uv

# Install AutoGluon
python -m uv pip install autogluon --extra-index-url https://download.pytorch.org/whl/cpu

警告

macOS 尚不支持 GPU 使用，请使用 Linux 或 Windows 在 AutoGluon 中利用 GPU。

conda create -n ag python=3.11
conda activate ag
conda install -c conda-forge mamba
mamba install -c conda-forge autogluon

警告

macOS 尚不支持 GPU 使用，请使用 Linux 或 Windows 在 AutoGluon 中利用 GPU。

MacOS 上的 LightGBM 支持 (LibOMP)

AutoGluon 的依赖项 LightGBM 使用 libomp 进行多线程处理。如果您通过 brew install libomp 安装 libomp，可能会因库版本不兼容而遇到段错误。请使用以下命令安装兼容版本

# Uninstall libomp if it was previous installed
brew uninstall -f libomp
wget https://raw.githubusercontent.com/Homebrew/homebrew-core/fb8323f2b170bd4ae97e1bac9bf3e2983af3fdb0/Formula/libomp.rb
brew install libomp.rb
rm libomp.rb

pip install -U pip
pip install -U setuptools wheel

git clone https://github.com/autogluon/autogluon
cd autogluon && ./full_install.sh

警告

macOS 尚不支持 GPU 使用，请使用 Linux 或 Windows 在 AutoGluon 中利用 GPU。

注意

如果您在 Windows 上安装 AutoGluon 时遇到困难，请在此 GitHub Issue 中提供详细信息。

建议在 Windows 上使用 Anaconda 安装 AutoGluon

  1. 安装 Anaconda

    • 如果 Anaconda 已安装但版本较旧，请按照本指南进行更新

  2. 打开 Anaconda Prompt (anaconda3)

  3. 在 Anaconda Prompt 中，执行以下操作

conda create -n myenv python=3.11 -y
conda activate myenv

  1. 使用上面创建的 conda 环境继续剩余的安装步骤

pip install -U pip
pip install -U setuptools wheel
pip install autogluon --extra-index-url https://download.pytorch.org/whl/cpu

注意

如果您在 Windows 上安装 AutoGluon 时遇到困难，请在此 GitHub Issue 中提供详细信息。

建议在 Windows 上使用 Anaconda 安装 AutoGluon

  1. 安装 Anaconda

    • 如果 Anaconda 已安装但版本较旧，请按照本指南进行更新

  2. 打开 Anaconda Prompt (anaconda3)

  3. 在 Anaconda Prompt 中，执行以下操作

conda create -n myenv python=3.11 cudatoolkit=11.3 -y
conda activate myenv

  1. 按照 PyTorch 安装文档安装正确的 GPU PyTorch 版本（推荐）。或者，使用以下命令

pip install torchvision==0.19.1 --force-reinstall --extra-index-url https://download.pytorch.org/whl/cu121

  1. 通过在 Python 中测试来验证您的安装是否有效并能检测到您的 GPU

import torch
print(torch.cuda.is_available())  # Should be True
print(torch.cuda.device_count())  # Should be > 0

  1. 使用上面创建的 conda 环境继续剩余的安装步骤

pip install -U pip
pip install -U setuptools wheel
pip install autogluon

注意

如果您在 Windows 上安装 AutoGluon 时遇到困难，请在此 GitHub Issue 中提供详细信息。

建议在 Windows 上使用 Anaconda 安装 AutoGluon

  1. 安装 Anaconda

    • 如果 Anaconda 已安装但版本较旧，请按照本指南进行更新

  2. 打开 Anaconda Prompt (anaconda3)

  3. 在 Anaconda Prompt 中，执行以下操作

conda create -n myenv python=3.11 -y
conda activate myenv

  1. 使用上面创建的 conda 环境继续剩余的安装步骤

# Install UV package installer (faster than pip)
pip install -U uv

# Install AutoGluon
python -m uv pip install autogluon --extra-index-url https://download.pytorch.org/whl/cpu

注意

如果您在 Windows 上安装 AutoGluon 时遇到困难，请在此 GitHub Issue 中提供详细信息。

建议在 Windows 上使用 Anaconda 安装 AutoGluon

  1. 安装 Anaconda

    • 如果 Anaconda 已安装但版本较旧，请按照本指南进行更新

  2. 打开 Anaconda Prompt (anaconda3)

  3. 在 Anaconda Prompt 中，执行以下操作

conda create -n myenv python=3.11 cudatoolkit=11.3 -y
conda activate myenv

  1. 按照 PyTorch 安装文档安装正确的 GPU PyTorch 版本（推荐）。或者，使用以下命令

pip install torchvision==0.19.1 --force-reinstall --extra-index-url https://download.pytorch.org/whl/cu121

  1. 通过在 Python 中测试来验证您的安装是否有效并能检测到您的 GPU

import torch
print(torch.cuda.is_available())  # Should be True
print(torch.cuda.device_count())  # Should be > 0

  1. 使用上面创建的 conda 环境继续剩余的安装步骤

# Install UV package installer (faster than pip)
pip install -U uv

# Install AutoGluon with GPU support
python -m uv pip install autogluon

conda create -n ag python=3.10
conda activate ag
conda install -c conda-forge mamba
mamba install -c conda-forge autogluon
mamba install -c conda-forge "ray-tune >=2.10.0,<2.32" "ray-default >=2.10.0,<2.32"  # install ray for faster training

conda create -n ag python=3.11
conda activate ag
conda install -c conda-forge mamba
mamba install -c conda-forge -c pytorch -c nvidia autogluon "pytorch=*=*cuda*"
mamba install -c conda-forge "ray-tune >=2.10.0,<2.32" "ray-default >=2.10.0,<2.32"  # install ray for faster training

注意

如果您在 Windows 上安装 AutoGluon 时遇到困难，请在此 GitHub Issue 中提供详细信息。

建议在 Windows 上使用 Anaconda 安装 AutoGluon

  1. 安装 Anaconda

    • 如果 Anaconda 已安装但版本较旧，请按照本指南进行更新

  2. 打开 Anaconda Prompt (anaconda3)

  3. 在 Anaconda Prompt 中，执行以下操作

conda create -n myenv python=3.11 -y
conda activate myenv

  1. 使用上面创建的 conda 环境继续剩余的安装步骤

pip install uv
python -m uv pip install -U torch torchvision --extra-index-url https://download.pytorch.org/whl/cpu
git clone https://github.com/autogluon/autogluon
cd autogluon && ./full_install.sh

注意

如果您在 Windows 上安装 AutoGluon 时遇到困难，请在此 GitHub Issue 中提供详细信息。

建议在 Windows 上使用 Anaconda 安装 AutoGluon

  1. 安装 Anaconda

    • 如果 Anaconda 已安装但版本较旧，请按照本指南进行更新

  2. 打开 Anaconda Prompt (anaconda3)

  3. 在 Anaconda Prompt 中，执行以下操作

conda create -n myenv python=3.11 cudatoolkit=11.3 -y
conda activate myenv

  1. 按照 PyTorch 安装文档安装正确的 GPU PyTorch 版本（推荐）。或者，使用以下命令

pip install torchvision==0.19.1 --force-reinstall --extra-index-url https://download.pytorch.org/whl/cu121

  1. 通过在 Python 中测试来验证您的安装是否有效并能检测到您的 GPU

import torch
print(torch.cuda.is_available())  # Should be True
print(torch.cuda.device_count())  # Should be > 0

  1. 使用上面创建的 conda 环境继续剩余的安装步骤

git clone https://github.com/autogluon/autogluon
cd autogluon && ./full_install.sh
安装特定的 AutoGluon 模块和依赖项

AutoGluon 被模块化为专门用于表格、多模态或时间序列数据的子模块。您可以通过仅安装特定子模块来减少所需的依赖项数量，命令为：pip install <submodule>，其中 <submodule> 可以是以下选项之一

  • autogluon.tabular - 表格数据功能 (TabularPredictor)

    • 独立安装 autogluon.tabular 的默认方式是一个骨架安装。

    • 通过 pip install autogluon.tabular[all] 安装以获得与 pip install autogluon 相同的表格数据功能安装。

    • 可用的可选依赖项：lightgbm,catboost,xgboost,fastai,ray。这些包含在 all 中。

    • 未包含在 all 中的可选依赖项：imodels,skex,skl2onnx。

    • 例如，要仅使用可选的 LightGBM 和 CatBoost 模型运行 autogluon.tabular，您可以执行：pip install autogluon.tabular[lightgbm,catboost]

    • 可选依赖项：skex。这将使 CPU 上的 KNN 模型训练和推理速度提高 25 倍。使用 pip install autogluon.tabular[all,skex] 启用。注意：不兼容 ARM 处理器。

    • 实验性可选依赖项：imodels。这将安装 imodels 包，并允许您在 TabularPredictor 中拟合可解释模型。

    • 可选依赖项：skl2onnx。这将通过 predictor.compile() 在支持的模型上启用 ONNX 模型编译。

  • autogluon.multimodal - 用于图像、文本和多模态问题的功能。专注于深度学习模型。

    • 要尝试使用 MultiModalPredictor 的目标检测功能，请通过 mim install "mmcv==2.1.0"、pip install "mmdet==3.2.0" 和 pip install pycocotools 安装额外的依赖项。请注意，Windows 用户还应通过 pip install pycocotools-windows 安装 pycocotools，但这仅支持 python 3.6/3.7/3.8。

  • autogluon.timeseries - 仅用于时间序列数据的功能 (TimeSeriesPredictor)。

  • autogluon.common - 辅助功能。不适合独立使用。

  • autogluon.core - 仅包含核心功能 (Searcher/Scheduler)，适用于任意代码/模型的超参数调优。

  • autogluon.features - 仅包含特征生成/特征预处理管道的功能（主要与表格数据相关）。

  • autogluon.eda - （已弃用）仅包含探索性数据分析功能。

要从源码安装子模块，请按照从源码安装整个包的说明进行，但将 cd autogluon && ./full_install.sh 这一行替换为 cd autogluon && pip install -e {SUBMODULE_NAME}/{OPTIONAL_DEPENDENCIES}

  • 例如，要从源码安装 autogluon.tabular[lightgbm,catboost]，命令将是：cd autogluon && pip install -e tabular/[lightgbm,catboost]

安装所有 AutoGluon 可选依赖项

pip install autogluon && pip install autogluon.tabular[imodels,skex,skl2onnx]

Amazon SageMaker Studio 中的 AutoGluon

Amazon SageMaker Distribution 是用于数据科学的 docker 环境，作为 JupyterLab 笔记本实例和 Code Editor 在 Amazon SageMaker Studio 中的默认镜像使用。AutoGluon 库预装在所有版本的 Amazon SageMaker Distribution 中。SageMaker Studio 用户无需安装任何额外内容即可访问 AutoGluon 的自动化功能。

要查找 SageMaker Distribution 镜像中可用的 AutoGluon 和 PyTorch 版本，请参阅 SageMaker Distribution GitHub 存储库中您镜像版本的 RELEASE.md 文件。

从源码安装特定拉取请求

为了测试拉取请求而从源码构建 AutoGluon，您可以按照这些说明克隆并安装确切的分支。如果您是代码评审者或想测试某个 PR 是否修复了您报告的错误，此过程非常有用。

在此示例中，我们使用这个 PR。它来自用户 innixma，PR 分支名为 accel_preprocess_bool。此信息直接在 PR 页面的标题下方提供（其中显示 into autogluon:master from Innixma:accel_preprocess_bool）。

# Edit these two variables to change which PR / branch is being installed
GITHUB_USER=innixma
BRANCH=accel_preprocess_bool

pip install -U pip
git clone --depth 1 --single-branch --branch ${BRANCH} --recurse-submodules https://github.com/${GITHUB_USER}/autogluon.git
cd autogluon && ./full_install.sh

请注意，上述示例仅在分支仍然存在时有效。用户可以在 PR 合并后删除该分支，因此此建议主要针对未合并的 PR。

安装夜间构建版本

AutoGluon 提供夜间构建版本，可以使用 --pre 参数安装。夜间构建版本包含最新功能，但尚未像稳定版本那样经过严格测试。

pip install -U uv
python -m uv pip install autogluon
M1 和 M2 Apple Silicon

Apple Silicon 现在通过上面概述的 conda 安装说明得到支持。如果用户的机器支持 GPU，conda-forge 将安装 GPU 版本。

Kaggle

AutoGluon 被 Kaggle 社区积极使用。您可以在这里找到数百个使用 AutoGluon 的 Kaggle notebook。

对于允许在 notebook 中访问互联网的 Kaggle 比赛，您可以在 notebook 开头通过以下行安装 AutoGluon

!pip install -U autogluon > /dev/null

对于不允许访问互联网的比赛，您可以通过使用 Kaggle 社区打包的 AutoGluon Artifact（以 Kaggle 数据集的形式）来获取 AutoGluon。

如果您在安装 AutoGluon 后遇到问题，请尝试重启 notebook 运行时以确保内存状态干净。

故障排除

如果您遇到此处未涵盖的安装问题，请创建一个 GitHub issue。