ChilmAI

ChilmAI

pytest pytest windows coverage 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）では、GitHub Releases の ChilmAI-vX.Y.Z.zip を展開し、ChilmAI.exe を実行すると Web UI を利用できます。インストールや起動時の注意点は自治体の方へのクイックスタートを参照してください。

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

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

pip install chilmai

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

Python 3.10 〜 3.12、Git、uv を用意して、依存関係をインストールします。

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

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

ドキュメント

コントリビューション

バグ報告、機能提案、ドキュメント改善、Pull Request を歓迎します。参加方法は CONTRIBUTING.md を参照してください。セキュリティ上の懸念は公開 Issue に投稿せず、SECURITY.md に記載された方法で報告してください。

ライセンス

Apache License 2.0

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.1.6)

Owner

PyPI data
Data sourced directly from PyPI's database.

License expression

Apache-2.0
View SPDX License List

Requires

Python <3.13, >=3.10

Provides Extra

package test format docs

Report project as malware

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.2.tar.gz (56.0 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.2-py3-none-any.whl (63.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chilmai-0.1.2.tar.gz
  • Upload date:
  • Size: 56.0 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.2.tar.gz
Algorithm Hash digest
SHA256 5df573d6c1302e7da9a2d253c6ae44fd957549b17d64caddca34719f658ff9a2
MD5 60be390198ce9918c04213141e975e5b
BLAKE2b-256 626721a8c57be42e715465c17b55788189f952eaf37c9ced6c0b3b7448a42e7c

See more details on using hashes here.

Provenance

The following attestation bundles were made for chilmai-0.1.2.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.2-py3-none-any.whl.

File metadata

  • Download URL: chilmai-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 63.3 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7e5337962061984d74ced34806749a021d0bed539fe807a19c00398615969921
MD5 36e57b65c7350824d7c2e63978866409
BLAKE2b-256 7f0e04072cf83e74a70b4cc433de5687658400a487c60031bb126a35ac12b350

See more details on using hashes here.

Provenance

The following attestation bundles were made for chilmai-0.1.2-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