Python に XGBoost をインストールする

XGBoost は、勾配ブースティング決定木のオープンソースライブラリです。Python から使うには、プロジェクトで使用する環境に pip または conda でインストールします。ビルドをカスタマイズしたい場合や、パッケージ版が対応していない環境で使う場合は、ソースからのビルドが上級者向けの選択肢になります。

インストール方法を選ぶ

プロジェクトで pip と標準的な Python 環境を使っている場合は、pip を選びます。conda でプロジェクトを管理しており、環境とパッケージ管理ツールで依存関係をまとめて管理したい場合は、conda を選びます。環境内でパッケージ管理ツールを混在させると、依存関係の解決に影響することがあるため、その仕組みを理解していない場合は避けてください。

まず使用する環境を選択または有効化し、その環境のパッケージ管理ツールを実行します。以下のパッケージコマンドは、この記事の執筆時点では実行していません。インストール前に公式 XGBoost インストールガイドとリリース情報を確認し、現在のパッケージ手順と、対応する Python およびプラットフォームの組み合わせを確認してください。

pip で XGBoost をインストールする

使用する Python 環境のターミナルで、python -m pip install xgboost を実行します。python -m pip を使うと pip がそのインタープリターに関連付けられるため、別の Python 環境にインストールしてしまうのを防ぎやすくなります。コマンド名が python3 のシステムでは、代わりに python3 -m pip install xgboost を実行してください。

既存の pip インストールを更新するには、同じ環境で python -m pip install --upgrade xgboost を実行します。pip が表示する依存関係や互換性に関するメッセージを確認し、以下の検証手順でインストールを確かめてください。

conda で XGBoost をインストールする

プロジェクトで使用する conda 環境を有効にしてから、公式 XGBoost インストールガイドに記載されている conda-forge のコマンドを実行します。現在のコマンドは conda install -c conda-forge py-xgboost です。このコマンドは conda-forge チャンネルと Python パッケージを指定します。パッケージの提供状況はプラットフォームやリリースによって異なることがあるため、インストールまたは更新の前にガイドを確認し、使用する環境に記載されたパッケージ名とチャンネルを使ってください。

XGBoost をソースからビルドする

ソースからのビルドは、XGBoost をカスタマイズする必要がある場合や、利用可能なパッケージではプラットフォームや要件に対応できない場合に選ぶ上級者向けの方法です。使用する OS とリリースに応じた前提条件とコマンドは、公式 XGBoost ソースビルドガイドを参照してください。このガイドではネイティブのビルド手順と Python パッケージのインストール方法が説明されています。ビルド要件やコマンドは変わることがあるため、一般的な手順ではなく、ガイドにある最新の手順に従ってください。生成された Python パッケージは、プロジェクトで使用する環境と同じ環境にインストールします。

インストールを確認し、よくある問題を解決する

プロジェクトで選択した Python インタープリターを使って、この単体で実行できる確認コードを実行します。インストールされている XGBoost のバージョンが表示されます。インタープリターからパッケージが見つからない場合は、明確なメッセージが表示されます。この例に表示されるメッセージの文面は英語のままです。

import importlib.util

if importlib.util.find_spec("xgboost") is None:
    print("XGBoost is not installed in this Python environment.")
else:
    import xgboost

    print(f"XGBoost {xgboost.__version__}")

XGBoost is not installed in this Python environment.

インストール後も XGBoost が見つからないと確認コードに表示された場合は、インストール時に使ったインタープリターと、アプリケーションの実行に使っているインタープリターを照合してください。pip では python -m pip show xgboost を実行すると、そのインタープリターに関連付けられたパッケージを確認できます。conda では conda list xgboost を実行すると、有効な環境のパッケージを確認できます。インストールと検証は、同じ環境を有効にした状態で行ってください。環境が一致している場合は、import 時のエラー全文を確認し、依存関係を変更する前に、使用している OS、Python のバージョン、XGBoost のリリースに対応する公式インストール情報を参照してください。

よくある質問

仮想環境に XGBoost をインストールできますか？

はい。まず venv または conda の環境を有効にし、その環境のパッケージ管理ツールで XGBoost をインストールします。検証コードも、その環境の Python インタープリターで実行してください。

対応している Python のバージョンとプラットフォームを教えてください。

対応状況は XGBoost のリリースと、利用できるパッケージビルドによって異なります。インストールするリリースが対応している Python のバージョンとプラットフォームは、公式のリリース情報とインストール情報で確認してください。

XGBoost は他の機械学習ライブラリと一緒に使えますか？

XGBoost には Python パッケージがあり、Python プロジェクトで他のライブラリと併用できます。特定のライブラリとの連携については、そのライブラリの最新ドキュメントに従い、インストールした各バージョンに互換性があることを確認してください。