Optuna MCP

🚀 Optuna MCP Server

Optuna MCP Server是一個基於Model Context Protocol (MCP)的服務器，它藉助Optuna實現自動化優化與分析，能有效提升工作效率，為用戶提供便捷的優化解決方案。

🚀 快速開始

Optuna MCP Server在多個場景中都能發揮重要作用，以下是一些具體的使用場景示例：

• 通過大語言模型（LLMs）實現自動化超參數優化。
• 通過聊天界面交互式分析Optuna的優化結果。
• 優化其他MCP工具的輸入和輸出。

更多詳細信息，請查看示例部分。

📦 安裝指南

Optuna MCP服務器可以使用uv或Docker進行安裝。下面以Claude Desktop作為示例MCP客戶端，介紹如何安裝Optuna MCP服務器。

使用uv安裝

在開始安裝過程之前，請先從Astral安裝uv。

然後，將Optuna MCP服務器配置添加到MCP客戶端。若要將其添加到Claude Desktop中，請依次點擊Claude > 設置 > 開發者 > 編輯配置 > claude_desktop_config.json，並添加以下內容：

{
  "mcpServers": {
    "Optuna": {
      "command": "uvx",
      "args": [
        "optuna-mcp"
      ]
    }
  }
}

此外，你可以使用--storage參數指定Optuna存儲，以持久化結果：

{
  "mcpServers": {
    "Optuna": {
      "command": "uvx",
      "args": [
        "optuna-mcp",
        "--storage",
        "sqlite:///optuna.db"
      ]
    }
  }
}

添加完成後，請重新啟動Claude Desktop應用程序。有關Claude Desktop的更多信息，請查看快速入門頁面。

使用Docker安裝

你也可以使用Docker運行Optuna MCP服務器。請確保你的機器上已經安裝並運行了Docker。

{
  "mcpServers": {
    "Optuna": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "--net=host",
        "-v",
        "/PATH/TO/LOCAL/DIRECTORY/WHICH/INCLUDES/DB/FILE:/app/workspace",
        "optuna/optuna-mcp:latest",
        "--storage",
        "sqlite:////app/workspace/optuna.db"
      ]
    }
  }
}

✨ 主要特性

Optuna MCP提供了以下工具，具體而言，它提供了Optuna的基本功能，如研究（Study）、試驗（Trial）、可視化（Visualization）和儀表盤（Dashboard）。由於MCP客戶端了解工具列表和每個工具的詳細信息，用戶無需記憶這些細節。

研究（Study）

• create_study - 使用給定的研究名稱和優化方向創建一個新的Optuna研究。如果研究已經存在，則直接加載。
  • study_name : 研究名稱（字符串，必需）。
  • directions : 優化方向（由字面字符串minimize/maximize組成的列表，可選）。
• set_sampler - 為研究設置採樣器。
  • name : 採樣器名稱（字符串，必需）。
• get_all_study_names - 從存儲中獲取所有研究名稱。
• set_metric_names - 設置指標名稱。指標名稱用於區分每個目標值的標籤。
  • metric_names : 每個目標的指標名稱列表（字符串列表，必需）。
• get_metric_names - 獲取指標名稱。
  • 無需參數。
• get_directions - 獲取研究的優化方向。
  • 無需參數。
• get_trials - 以CSV格式獲取所有試驗。
  • 無需參數。
• best_trial - 獲取最佳試驗。
  • 無需參數。
• best_trials - 返回研究中位於帕累託前沿的試驗。
  • 無需參數。

試驗（Trial）

• ask - 使用Optuna建議新的參數。
  • search_space : Optuna的搜索空間（字典，必需）。
• tell - 報告試驗結果。
  • trial_number : 試驗編號（整數，必需）。
  • values : 試驗結果（浮點數或浮點數列表，必需）。
• set_trial_user_attr - 為試驗設置用戶屬性。
  • trial_number : 試驗編號（整數，必需）。
  • key : 用戶屬性的鍵（字符串，必需）。
  • value : 用戶屬性的值（任意類型，必需）。
• get_trial_user_attrs - 獲取試驗中的用戶屬性。
  • trial_number : 試驗編號（整數，必需）。

可視化（Visualization）

• plot_optimization_history - 以圖像形式返回優化歷史圖。
  • target : 指定要顯示的值的索引（整數，可選）。
  • target_name : 要在軸標籤上顯示的目標名稱（字符串，可選）。
• plot_hypervolume_history - 以圖像形式返回超體積歷史圖。
  • reference_point : 用於計算超體積的參考點列表（浮點數列表，必需）。
• plot_pareto_front - 以圖像形式返回多目標優化的帕累託前沿圖。
  • target_names : 用作軸標題的目標名稱列表（字符串列表，可選）。
  • include_dominated_trials : 包含所有被支配試驗的目標值的標誌（布爾值，可選）。
  • targets : 指定要顯示的目標值的索引列表（整數列表，可選）。
• plot_contour - 以圖像形式返回等高線圖。
  • params : 要可視化的參數列表（字符串列表，可選）。
  • target : 指定要顯示的值的索引（整數，必需）。
  • target_name : 要在顏色條上顯示的目標名稱（字符串，必需）。
• plot_parallel_coordinate - 以圖像形式返回平行座標圖。
  • params : 要可視化的參數列表（字符串列表，可選）。
  • target : 指定要顯示的值的索引（整數，必需）。
  • target_name : 要在軸標籤和圖例上顯示的目標名稱（字符串，必需）。
• plot_slice - 以圖像形式返回切片圖。
  • params : 要可視化的參數列表（字符串列表，可選）。
  • target : 指定要顯示的值的索引（整數，必需）。
  • target_name : 要在軸標籤上顯示的目標名稱（字符串，必需）。
• plot_param_importances - 以圖像形式返回參數重要性圖。
  • params : 要可視化的參數列表（字符串列表，可選）。
  • target : 指定要顯示的值的索引（整數/空，可選）。
  • target_name : 要在圖例上顯示的目標名稱（字符串，必需）。
• plot_edf - 以圖像形式返回經驗分佈函數（EDF）圖。
  • target : 指定要顯示的值的索引（整數，必需）。
  • target_name : 要在軸標籤上顯示的目標名稱（字符串，必需）。
• plot_timeline - 以圖像形式返回時間線圖。
  • 無需參數。
• plot_rank - 以圖像形式返回排名圖。
  • params : 要可視化的參數列表（字符串列表，可選）。
  • target : 指定要顯示的值的索引（整數，必需）。
  • target_name : 要在顏色條上顯示的目標名稱（字符串，必需）。

網絡儀表盤（Web Dashboard）

• launch_optuna_dashboard - 啟動Optuna儀表盤。
  • port : 服務器端口（整數，可選，默認值：58080）。

💻 使用示例

基礎用法

優化二維球面函數

以下是一個優化二維球面函數的簡單示例，同時展示了示例提示和大語言模型（LLM）響應的摘要：

啟動Optuna儀表盤並分析優化結果

你還可以通過MCP服務器啟動Optuna儀表盤，以交互式方式分析優化結果。

默認情況下，Optuna儀表盤將在端口58080上啟動。你可以在Web瀏覽器中訪問http://localhost:58080，如下所示：

Optuna儀表盤提供了各種可視化工具，用於分析優化結果，如優化歷史、參數重要性等。

優化FFmpeg編碼參數

此演示展示瞭如何使用Optuna MCP服務器自動找到最佳的FFmpeg編碼參數。它優化x264編碼選項，以在保證合理編碼時間的同時，最大化視頻質量（通過SSIM分數衡量）。

詳細信息請查看examples/ffmpeg.md。

優化餅乾配方

在這個示例中，我們將優化一個餅乾配方，參考了題為"Bayesian Optimization for a Better Dessert"的論文。

詳細信息請查看examples/cookie-recipe。

優化Matplotlib配置

此示例優化了Matplotlib配置。

詳細信息請查看examples/auto-matplotlib。

📄 許可證

本項目採用MIT許可證（請參閱LICENSE）。