Mlcbakery

🚀 MLC Bakery

MLC Bakeryは、Pythonベースのサービスで、FastAPIとSQLAlchemyを使用して構築され、機械学習（ML）モデルの血統と系譜を管理することができます。

🚀 クイックスタート

MLC Bakeryは、Pythonベースのサービスで、機械学習モデルの血統と系譜を管理するために設計されています。FastAPIとSQLAlchemyを使用して構築され、RESTful APIとWebインターフェイスを提供し、MLモデルの血統情報を表示および管理することができます。

✨ 主な機能

• RESTful API：機械学習モデルを管理するための作成、読み取り、更新、削除（CRUD）操作を提供します。
• 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 デコレータを使用して、認証が必要なエンドポイントを保護します。

📚 ドキュメント

環境変数

以下は、このプロジェクトで必要な環境変数です：

ログと監視

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サービスを簡単にインストール、設定、およびデプロイすることができます。