Skip to main content

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 ReleasesChilmAI-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 を歓迎します。参加方法は コントリビューション を参照してください。セキュリティ上の懸念は公開 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.3.tar.gz (56.1 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.3-py3-none-any.whl (63.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chilmai-0.1.3.tar.gz
  • Upload date:
  • Size: 56.1 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.3.tar.gz
Algorithm Hash digest
SHA256 d84fcf96794332e619a2a971a397e8e30647de4fa18c8ae8502dac66d194cf45
MD5 eb3ff8172b4871f7014fca5325b93e42
BLAKE2b-256 c09c15b8b06668c72588bdd50dbedb4c7492fdc2e30501162810d95dafa25fe5

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: chilmai-0.1.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2339c65fd56f71a5a2d57c40d38594b6e5ab46aace37c003766578391e226097
MD5 3fc87949772e680c3279e555c7b1603f
BLAKE2b-256 059791d12fc2a886c518ca51be314cd0913df131eaef0d69ace0a89ae8dd27eb

See more details on using hashes here.

Provenance

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