Pytorch Lightning MCP

🚀 PyTorch Lightning MCP Server

PyTorch Lightning MCP Server 是一個輕量級的集成層，它通過結構化、機器可讀的 API 為工具、代理和編排系統提供 PyTorch Lightning 功能。

🚀 快速開始

本項目允許你通過結構化、機器可讀的 API 來使用 PyTorch Lightning，可用於工具、代理和編排系統。

✨ 主要特性

• 提供用於訓練、檢查、驗證、測試、預測和模型檢查點的結構化 API。
• 支持 PyTorch Lightning 執行。
• 具備標準輸入輸出和 HTTP 服務器模式。

📦 安裝指南

環境要求

• Python 3.10 - 3.12
• PyTorch Lightning（兼容版本）
• uv（推薦用於依賴管理）

安裝命令

curl -Ls https://astral.sh/uv/install.sh | sh
git clone https://github.com/<your-org>/lightning-mcp.git
cd lightning-mcp
uv sync --all-extras

💻 使用示例

CLI 使用

你可以通過命令行界面（CLI）運行 MCP 服務器：

# 標準輸入輸出服務器（默認）
uv run lightning-mcp

# HTTP 服務器
uv run lightning-mcp --http --host 0.0.0.0 --port 3333

標準輸入輸出示例

echo '{"id":"1","method":"lightning.inspect","params":{"what":"environment"}}' | uv run lightning-mcp

HTTP 示例

curl -X POST http://localhost:3333/mcp \
  -H "Content-Type: application/json" \
  -d '{"id":"1","method":"lightning.inspect","params":{"what":"environment"}}'

📚 詳細文檔

可用工具

MCP 服務器提供以下工具（方法）：

lightning.train

使用顯式配置訓練 PyTorch Lightning 模型。 輸入模式：

{
  "model": {"_target_": "string", ...},
  "trainer": { ... }
}

lightning.inspect

檢查模型或運行時環境。 輸入模式：

{
  "what": "model | environment | summary",
  "model": {"_target_": "string", ...} // 模型檢查時必需
}

lightning.validate

驗證 PyTorch Lightning 模型。 輸入模式：

{
  "model": {"_target_": "string", ...},
  "trainer": { ... }
}

lightning.test

測試 PyTorch Lightning 模型。 輸入模式：

{
  "model": {"_target_": "string", ...},
  "trainer": { ... }
}

lightning.predict

使用 PyTorch Lightning 模型進行預測/推理。 輸入模式：

{
  "model": {"_target_": "string", ...},
  "trainer": { ... }
}

lightning.checkpoint

管理模型檢查點：保存、加載或列出。 輸入模式：

{
  "action": "save | load | list",
  "path": "string",         // 保存/加載時使用
  "directory": "string",    // 列出時使用
  "model": { ... }           // 保存/加載時使用
}

工具發現

要在運行時列出所有可用工具及其模式，請使用以下命令：

echo '{"id":"1","method":"tools/list","params":{}}' | uv run lightning-mcp

測試

uv run pytest

貢獻代碼

請參閱 CONTRIBUTING.md 和 DEVELOPMENT.md。

📄 許可證

本項目採用 Apache 2.0 許可證。