Mlcbakery

🚀 MLC Bakery

MLC Bakery 是一個基於 Python 的服務，用於管理機器學習模型的血統和譜系。它藉助 FastAPI 和 SQLAlchemy 構建，提供 RESTful API 與 Web 界面，方便查看和管理 ML 模型的血統信息。

🚀 快速開始

MLC Bakery 是一個基於 Python 的服務，用於管理機器學習模型的血統和譜系。它使用 FastAPI 和 SQLAlchemy 構建，提供了 RESTful API 和 Web 界面來查看和管理 ML 模型的血統信息。

✨ 主要特性

• RESTful API：提供創建、讀取、更新和刪除 (CRUD) 操作來管理 ML 模型。
• Web 界面：通過 Streamlit 提供直觀的 Web 界面來查看和管理模型的血統信息。
• Docker 支持：提供 Docker Compose 文件，方便部署到生產環境。
• 認證與授權：使用 JWT 進行身份驗證，確保 API 安全。

📦 安裝指南

快速開始

1. 克隆倉庫：

   git clone https://github.com/yourusername/mlc-bakery.git
   cd mlt-bakery
   

2. 創建虛擬環境並安裝依賴項：

   python -m venv env
   source env/bin/activate  # 對於 Windows 使用 `env\Scripts\activate`
   pip install -r requirements.txt
   

3. 配置環境變量： 創建一個 .env 文件，並添加以下內容：

   DB_URL=postgresql://postgres:password@localhost/mlc_bakery
   ADMIN_AUTH_TOKEN=your_secure_token_here
   

4. 啟動服務：

   uvicorn app.main:app --reload
   

5. 訪問 Web 界面： 打開瀏覽器，訪問 http://localhost:8000。

數據庫遷移

使用 Alembic 進行數據庫遷移：

1. 初始化 Alembic：

   alembic init migrations
   

2. 添加模型到遷移文件： 修改 migrations/versions/[timestamp]_[name].py 文件，將您的 ML 模型添加到 ml_models 表中。

3. 提交遷移：

   alembic revision --autogenerate -m "add ml models"
   alembic upgrade head
   

認證與授權

1. 創建一個 JWT 加密密鑰： 在 .env 文件中添加：

   SECRET_KEY=your_jwt_secret_key_here
   

2. 在 API 中使用 JWT 進行身份驗證： 修改 app/security.py 文件，實現 JWT 解析和用戶認證。

3. 保護敏感端點： 使用 Depends 和 security.get_current_user 裝飾器來保護需要認證的端點。

📚 詳細文檔

配置

環境變量

以下是項目所需的環境變量：

• DB_URL：數據庫連接 URL，格式為 postgresql://username:password@host/database_name。
• SECRET_KEY：JWT 加密密鑰。
• ADMIN_AUTH_TOKEN：管理員使用的認證令牌。

日誌與監控

1. 使用日誌記錄庫（如 SQLAlchemy 或 FastAPI 的默認日誌記錄）進行日誌記錄。
2. 配置日誌文件，將日誌輸出到文件或控制檯。

部署 (Docker Compose)

快速開始

1. 創建 Docker 網絡：

   docker network create caddy-network
   

2. 配置環境變量： 在 .env 文件中添加 ADMIN_AUTH_TOKEN 和其他必要配置。

3. 啟動服務：

   docker-compose up --build -d
   

4. 訪問服務：

   • API：http://localhost/docs
   • Streamlit 界面：http://streamlit.localhost
   • MCP 服務器：http://mcp.localhost

數據庫管理

1. 添加或刪除數據庫：

   docker compose exec db psql -U postgres -c "drop DATABASE mlcbakery;"
   docker compose exec db psql -U postgres -c "create DATABASE mlcbakery;"
   

2. 執行數據庫遷移：

   docker compose exec api alembic -c alembic.ini upgrade heads
   

📄 許可證

MIT License

重要說明

⚠️ 重要提示

• ADMIN_AUTH_TOKEN 必須配置管理員令牌，用於保護敏感端點。
• Docker 網絡部署時需要創建 caddy-network 網絡以確保服務之間通信正常。

通過以上步驟，您可以輕鬆地安裝、配置和部署 MLC Bakery 服務。