Skip to content

ChilmAI

ChilmAI

pytest pytest windows coverage
PyPI Python 3.10-3.12 Apache-2.0 arXiv 2401.07761

ChilmAI は、自治体の保育所利用調整における入所選考処理を支援する Python アプリケーションです。入力データのバリデーション、列名マッピング、きょうだい条件を含むマッチング、結果データの整形を行います。

利用方法や仕様の詳細は ChilmAI ドキュメント を参照してください。

主な構成

領域 パス 内容
コアライブラリ chilmai/generic ファイル読込、列名マッピング、バリデーション、マッチング実行、結果整形
ソルバー chilmai/algorithm/cp_use_transfer OR-Tools CP-SAT を用いたマッチング実装
リファレンス実装 apps FastAPI による HTTP API と Web UI
サンプルデータ sample 動作確認用の合成データ
テストコード test 単体テスト、API テスト、ブラウザテスト

Warning

apps/ 以下の Web UI と HTTP API はリファレンス実装です。本番運用に必要な認証、認可、監査ログ、運用監視、データ保護、インフラ設定、脆弱性対応は、利用環境に合わせて別途設計・実装してください。

使い方

Windows で Web UI を試す

Windows 11(64-bit)では、最新リリースの ChilmAI-latest.zip をダウンロードして展開し、ChilmAI.exe を実行すると Web UI を利用できます。インストールや起動時の注意点は自治体の方へのクイックスタートを参照してください。

ライブラリとして利用する

Python 3.10 〜 3.12 の環境に、PyPI からインストールします。パッケージに含まれるのはコアライブラリ(chilmai)のみで、Web UI・HTTP API のリファレンス実装(apps/)とサンプルデータは含まれません。

pip install chilmai

uv でプロジェクトに追加する場合は次のとおりです。

uv add chilmai

ソースコードから利用する

Git、Python 3.10 〜 3.12、uv を用意して、依存関係をインストールします。Web UI を利用する場合は、Microsoft Edge や Google Chrome などのモダンブラウザも必要です。

git clone https://github.com/CyberAgent/ChilmAI.git
cd ChilmAI
uv sync

Python API のサンプルは インストールと実行、Web UI と HTTP API の起動方法は リファレンスアプリ を参照してください。

ドキュメント

コントリビューション

バグ報告、機能提案、ドキュメント改善、Pull Request を歓迎します。参加方法は コントリビューション を参照してください。コミュニティでのやり取りには 行動規範日本語訳)が適用されます。セキュリティ上の懸念は公開 Issue に投稿せず、セキュリティ に記載された方法で報告してください。

ライセンス

Apache License 2.0

Releases

Used by

Contributors

Languages