Skip to main 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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chilmai-0.1.6.tar.gz (58.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

chilmai-0.1.6-py3-none-any.whl (65.2 kB view details)

Uploaded Python 3

File details

Details for the file chilmai-0.1.6.tar.gz.

File metadata

  • Download URL: chilmai-0.1.6.tar.gz
  • Upload date:
  • Size: 58.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for chilmai-0.1.6.tar.gz
Algorithm Hash digest
SHA256 615712eb862b97c65b872d39e2e26db75e840c3cb6a85f9b4ae90a6fe27f28be
MD5 4674545adb7eaaf0b5b4532fc807d095
BLAKE2b-256 e1f36ca4b0b3d4990a32625f9833fbc889e534bff0c314f293ff68565cd73e47

See more details on using hashes here.

Provenance

The following attestation bundles were made for chilmai-0.1.6.tar.gz:

Publisher: pypi_publish.yml on CyberAgent/ChilmAI

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file chilmai-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: chilmai-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 65.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for chilmai-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 01a29997acb8b090f80e4a4e56f00ca76f4de05d8b0ebc6dcd2c8fd4376ff12b
MD5 b744c3eeda91336173a21a1449883243
BLAKE2b-256 be44e455a2e30f45b0c036c8fc97db38e1d58c7c91a633d02a0dd02a9afb4eda

See more details on using hashes here.

Provenance

The following attestation bundles were made for chilmai-0.1.6-py3-none-any.whl:

Publisher: pypi_publish.yml on CyberAgent/ChilmAI

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page