> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-serverless-sft-revamp.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# XGBoost Sweeps

export const ColabLink = ({url}) => <a href={url} target="_blank" rel="noopener noreferrer" className="colab-link">
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M14.25.18l.9.2.73.26.59.3.45.32.34.34.25.34.16.33.1.3.04.26.02.2-.01.13V8.5l-.05.63-.13.55-.21.46-.26.38-.3.31-.33.25-.35.19-.35.14-.33.1-.3.07-.26.04-.21.02H8.77l-.69.05-.59.14-.5.22-.41.27-.33.32-.27.35-.2.36-.15.37-.1.35-.07.32-.04.27-.02.21v3.06H3.17l-.21-.03-.28-.07-.32-.12-.35-.18-.36-.26-.36-.36-.35-.46-.32-.59-.28-.73-.21-.88-.14-1.05-.05-1.23.06-1.22.16-1.04.24-.87.32-.71.36-.57.4-.44.42-.33.42-.24.4-.16.36-.1.32-.05.24-.01h.16l.06.01h8.16v-.83H6.18l-.01-2.75-.02-.37.05-.34.11-.31.17-.28.25-.26.31-.23.38-.2.44-.18.51-.15.58-.12.64-.1.71-.06.77-.04.84-.02 1.27.05zm-6.3 1.98l-.23.33-.08.41.08.41.23.34.33.22.41.09.41-.09.33-.22.23-.34.08-.41-.08-.41-.23-.33-.33-.22-.41-.09-.41.09zm13.09 3.95l.28.06.32.12.35.18.36.27.36.35.35.47.32.59.28.73.21.88.14 1.04.05 1.23-.06 1.23-.16 1.04-.24.86-.32.71-.36.57-.4.45-.42.33-.42.24-.4.16-.36.09-.32.05-.24.02-.16-.01h-8.22v.82h5.84l.01 2.76.02.36-.05.34-.11.31-.17.29-.25.25-.31.24-.38.2-.44.17-.51.15-.58.13-.64.09-.71.07-.77.04-.84.01-1.27-.04-1.07-.14-.9-.2-.73-.25-.59-.3-.45-.33-.34-.34-.25-.34-.16-.33-.1-.3-.04-.25-.02-.2.01-.13v-5.34l.05-.64.13-.54.21-.46.26-.38.3-.32.33-.24.35-.2.35-.14.33-.1.3-.06.26-.04.21-.02.13-.01h5.84l.69-.05.59-.14.5-.21.41-.28.33-.32.27-.35.2-.36.15-.36.1-.35.07-.32.04-.28.02-.21V6.07h2.09l.14.01.21.03zm-6.47 14.25l-.23.33-.08.41.08.41.23.33.33.23.41.08.41-.08.33-.23.23-.33.08-.41-.08-.41-.23-.33-.33-.23-.41-.08-.41.08z" />
    </svg>
    Try in Colab
  </a>;

<ColabLink url="https://colab.research.google.com/github/wandb/examples/blob/master/colabs/boosting/Using_W&B_Sweeps_with_XGBoost.ipynb" />

W\&B を使用して、機械学習の 実験管理 、 データセット の バージョン管理 、そして プロジェクト でのコラボレーションを実現しましょう。

<Frame>
  <img src="https://mintcdn.com/wb-21fd5541-serverless-sft-revamp/k60V_Bn1-o89Fhr9/images/tutorials/huggingface-why.png?fit=max&auto=format&n=k60V_Bn1-o89Fhr9&q=85&s=5ece2d47d1dad38766e378726c303f51" alt="Benefits of using W&B" width="4672" height="816" data-path="images/tutorials/huggingface-why.png" />
</Frame>

ツリー ベースの モデル から最高のパフォーマンスを引き出すには、 [適切なハイパーパラメーターの選択](https://blog.cambridgespark.com/hyperparameter-tuning-in-xgboost-4ff9100a3b2f) が不可欠です。
`early_stopping_rounds` は何回にすべきか？ ツリー の `max_depth` はどのくらいが適切か？

高次元の ハイパーパラメーター 空間を探索して最もパフォーマンスの高い モデル を見つけ出す作業は、すぐに手に負えなくなることがあります。
Hyperparameter Sweeps は、 モデル 同士を競わせ、勝者を決定するための整理された効率的な手段を提供します。
これは、 ハイパーパラメーター の 値 の組み合わせを自動的に探索し、最適な 値 を見つけ出すことで実現されます。

このチュートリアルでは、W\&B を使用して 3 つの簡単なステップで XGBoost モデル に対して高度な ハイパーパラメーター探索 を実行する方法を説明します。

まずは、以下のプロットをチェックしてみてください：

<Frame>
  <img src="https://mintcdn.com/wb-21fd5541-serverless-sft-revamp/nnIqJ01CGwOGYvb1/images/tutorials/xgboost_sweeps/sweeps_xgboost.png?fit=max&auto=format&n=nnIqJ01CGwOGYvb1&q=85&s=aad93427a7791f52ee3221f6635cc45e" alt="sweeps_xgboost" width="1043" height="864" data-path="images/tutorials/xgboost_sweeps/sweeps_xgboost.png" />
</Frame>

## Sweeps: 概要

W\&B で ハイパーパラメーター探索 を実行するのは非常に簡単です。以下の 3 つのステップに従うだけです：

1. **sweep を定義する:** どの パラメータ を探索するか、どの探索戦略を使用するか、どの メトリクス を最適化するかを指定する 辞書 形式の オブジェクト を作成します。

2. **sweep を初期化する:** 1 行の コード で sweep を初期化し、 sweep configuration の 辞書 を渡します：
   `sweep_id = wandb.sweep(sweep_config)`

3. **sweep agent を実行する:** これも 1 行の コード で実行できます。 `wandb.agent()` を呼び出し、 `sweep_id` と共に、 モデル アーキテクチャー を定義して トレーニング を行う関数を渡します：
   `wandb.agent(sweep_id, function=train)`

ハイパーパラメーター探索 を実行するために必要な作業はこれだけです。

以下の ノートブック では、これら 3 つのステップについて詳しく説明します。

この ノートブック をフォークして、 パラメータ を調整したり、自身の データセット で モデル を試したりすることを強くお勧めします。

### リソース

* [Sweeps ドキュメント →](/models/sweeps/)
* [コマンドラインからの起動 →](https://www.wandb.com/articles/hyperparameter-tuning-as-easy-as-1-2-3)

```python theme={null}
!pip install wandb -qU
```

```python theme={null}
import wandb
wandb.login()
```

## 1. Sweep を定義する

W\&B Sweeps では、わずか数行の コード で、思い通りに sweep を 設定 するための強力なレバーが提供されます。 sweep 設定 は [辞書または YAML ファイル](/models/sweeps/define-sweep-configuration/) として定義できます。

主な設定項目を見ていきましょう：

* **Metric (メトリクス)**: これは sweep が最適化しようとする指標です。 メトリクス には `name` ( トレーニングスクリプト で ログ を記録する名前) と `goal` (`maximize` (最大化) または `minimize` (最小化)) を指定できます。
* **Search Strategy (探索戦略)**: `"method"` キーを使用して指定します。 Sweeps ではいくつかの異なる探索戦略をサポートしています。
* **Grid Search (グリッド検索)**: ハイパーパラメーター の 値 のあらゆる組み合わせを反復します。
* **Random Search (ランダム検索)**: ランダムに選択された ハイパーパラメーター の 値 の組み合わせを反復します。
* **Bayesian Search (ベイズ探索)**: ハイパーパラメーター と メトリクス スコアの確率をマッピングする確率的 モデル を作成し、 メトリクス を改善する可能性が高い パラメータ を選択します。 ベイズ最適化 の目的は、 ハイパーパラメーター の 値 の選択により多くの時間をかける代わりに、試行する ハイパーパラメーター の 値 の回数を減らすことにあります。
* **Parameters (パラメータ)**: ハイパーパラメーター 名と、各反復でその 値 を取得するための 離散値 、範囲、または分布を含む 辞書 です。

詳細については、 [すべての sweep configuration オプションのリスト](/models/sweeps/define-sweep-configuration/) を参照してください。

```python theme={null}
sweep_config = {
    "method": "random", # grid または random を試してください
    "metric": {
      "name": "accuracy",
      "goal": "maximize"   
    },
    "parameters": {
        "booster": {
            "values": ["gbtree","gblinear"]
        },
        "max_depth": {
            "values": [3, 6, 9, 12]
        },
        "learning_rate": {
            "values": [0.1, 0.05, 0.2]
        },
        "subsample": {
            "values": [1, 0.5, 0.3]
        }
    }
}
```

## 2. Sweep を初期化する

`wandb.sweep` を呼び出すと、 Sweep Controller が起動します。これは、問い合わせてきたものに対して `parameters` の 設定 を提供し、 `wandb` の ログ 記録を通じて `metrics` のパフォーマンスが返されるのを待機する集中型 プロセス です。

```python theme={null}
sweep_id = wandb.sweep(sweep_config, project="XGBoost-sweeps")
```

### トレーニングプロセスの定義

sweep を実行する前に、 モデル を作成して トレーニング する関数を定義する必要があります。これは、 ハイパーパラメーター の 値 を受け取り、 メトリクス を出力する関数です。

また、 スクリプト に `wandb` を統合する必要があります。主に 3 つのコンポーネントがあります：

* `wandb.init()`: 新しい W\&B Run を初期化します。各 Run は トレーニングスクリプト の 1 回の実行を指します。
* `run.config`: すべての ハイパーパラメーター を 設定 オブジェクト に保存します。これにより、 [W\&B のアプリ](https://wandb.ai) を使用して、 ハイパーパラメーター の 値 ごとに Run を並べ替えたり比較したりできます。
* `run.log()`: メトリクス や、画像、動画、音声ファイル、HTML、プロット、ポイントクラウドなどのカスタム オブジェクト を ログ に記録します。

また、 データをダウンロードする必要もあります。

```python theme={null}
!wget https://raw.githubusercontent.com/jbrownlee/Datasets/master/pima-indians-diabetes.data.csv
```

```python theme={null}
# Pima Indians データセット用の XGBoost モデル
from numpy import loadtxt
from xgboost import XGBClassifier
from sklearn.model_selection import train_test_split
from sklearn.metrics import accuracy_score

# データをロード
def train():
  config_defaults = {
    "booster": "gbtree",
    "max_depth": 3,
    "learning_rate": 0.1,
    "subsample": 1,
    "seed": 117,
    "test_size": 0.33,
  }

  with wandb.init(config=config_defaults)  as run: # デフォルト値は sweep 中に上書きされます
    config = run.config

    # データをロードし、特徴量とターゲットに分割
    dataset = loadtxt("pima-indians-diabetes.data.csv", delimiter=",")
    X, Y = dataset[:, :8], dataset[:, 8]

    # データをトレーニングセットとテストセットに分割
    X_train, X_test, y_train, y_test = train_test_split(X, Y,
                                                        test_size=config.test_size,
                                                        random_state=config.seed)

    # トレーニングデータでモデルを適合
    model = XGBClassifier(booster=config.booster, max_depth=config.max_depth,
                          learning_rate=config.learning_rate, subsample=config.subsample)
    model.fit(X_train, y_train)

    # テストデータで予測
    y_pred = model.predict(X_test)
    predictions = [round(value) for value in y_pred]

    # 予測を評価
    accuracy = accuracy_score(y_test, predictions)
    print(f"Accuracy: {accuracy:.0%}")
    run.log({"accuracy": accuracy})
```

## 3. Agent で Sweep を実行する

次に、 `wandb.agent` を呼び出して sweep を開始します。

W\&B にログインしており、以下のものがある任意のマシンで `wandb.agent` を呼び出すことができます：

* `sweep_id`
* データセット と `train` 関数

そのマシンが sweep に参加します。

> *注意*: `random` (ランダム) スイープは、デフォルトでは新しい パラメータ の組み合わせを延々と試し続けます。これを止めるには、 [アプリの UI から sweep をオフにする](/models/sweeps/sweeps-ui/) か、 `agent` に完了させたい合計 Run 数 `count` を指定します。

```python theme={null}
wandb.agent(sweep_id, train, count=25)
```

## 結果の可視化

sweep が完了したら、 結果 を確認しましょう。

W\&B は、いくつかの有用なプロットを自動的に生成します。

### 並行座標プロット (Parallel coordinates plot)

このプロットは、 ハイパーパラメーター の 値 と モデル の メトリクス をマッピングします。最高の モデル パフォーマンスにつながった ハイパーパラメーター の組み合わせを絞り込むのに役立ちます。

このプロットからは、学習器として ツリー を使用した方が、単純な線形 モデル を使用するよりも、驚くほどではないにせよ、わずかにパフォーマンスが良いことが示唆されています。

<Frame>
  <img src="https://mintcdn.com/wb-21fd5541-serverless-sft-revamp/nnIqJ01CGwOGYvb1/images/tutorials/xgboost_sweeps/sweeps_xgboost2.png?fit=max&auto=format&n=nnIqJ01CGwOGYvb1&q=85&s=f4cff61689b1027fd643bee59086f7f2" alt="sweeps_xgboost" width="1381" height="717" data-path="images/tutorials/xgboost_sweeps/sweeps_xgboost2.png" />
</Frame>

### パラメータの重要度プロット (Hyperparameter importance plot)

パラメータの重要度プロット は、どの ハイパーパラメーター の 値 が メトリクス に最も大きな影響を与えたかを示します。

相関関係 (線形予測子として扱う) と 特徴量の重要度 ( 結果 に対してランダムフォレストを トレーニング した後) の両方をレポートするため、どの パラメータ が最も大きな影響を与えたか、そしてその影響が正であったか負であったかを確認できます。

このチャートを見ると、上記の並行座標プロットで気づいた傾向が定量的に確認できます。 検証精度 に最も大きな影響を与えたのは学習器の選択であり、 `gblinear` 学習器は概して `gbtree` 学習器よりも劣っていました。

<Frame>
  <img src="https://mintcdn.com/wb-21fd5541-serverless-sft-revamp/nnIqJ01CGwOGYvb1/images/tutorials/xgboost_sweeps/sweeps_xgboost3.png?fit=max&auto=format&n=nnIqJ01CGwOGYvb1&q=85&s=6bc6d8c8d0d5c921ac39895990884fc9" alt="sweeps_xgboost" width="1786" height="654" data-path="images/tutorials/xgboost_sweeps/sweeps_xgboost3.png" />
</Frame>

これらの 可視化 は、最も重要でさらなる探索の価値がある パラメータ (およびその 値 の範囲) に焦点を当てることで、コストのかかる ハイパーパラメーター 最適化を実行する際の時間とリソースの両方を節約するのに役立ちます。
