ChilmAI 0.1.2__py3-none-any.whl

chilmai/algorithm/cp_use_transfer/__init__.py

@@ -0,0 +1,6 @@
+"""ChilmAI が利用する OR-Tools ベースの保育所利用調整ソルバー。
+
+この package は低レイヤーの CP-SAT 実装を含む。
+通常の呼び出し元は、これらの module を直接 import せず、
+`chilmai.generic.service.MatchingService` を利用する。
+"""

chilmai/algorithm/cp_use_transfer/helper_functions.py

@@ -0,0 +1,348 @@
+import logging
+
+from chilmai.constants import UNMATCHED_DAYCARE_ID
+from .CP_agents import CP_Daycare, CP_Child, CP_Family
+
+logger = logging.getLogger(__name__)
+
+
+def get_agent(agent_id, agents):
+    """
+    指定 ID に対応する CP_agent インスタンスを返す（児童・保育所・世帯を含む）。
+    """
+    agent = next((x for x in agents if x.id == agent_id), None)
+    return agent
+
+
+def create_children(children_dic):
+    """
+    children_dic に保存されたデータから CP_Child インスタンスのリストを作成する。
+    """
+    children = []
+    for c_id in children_dic.keys():
+        c_id = children_dic[c_id]["id"]
+        age = children_dic[c_id]["age"]
+        if children_dic[c_id]["family_id"] is None:
+            family_id = children_dic[c_id]["id"]
+        else:
+            family_id = children_dic[c_id]["family_id"]
+        initial_daycare_id = (
+            UNMATCHED_DAYCARE_ID
+            if children_dic[c_id]["initial_daycare_id"] is None
+            else children_dic[c_id]["initial_daycare_id"]
+        )
+        preference_list = children_dic[c_id]["preference_list"]
+        # create a CP_Child instance
+        c = CP_Child(c_id, age, family_id, initial_daycare_id, preference_list)
+        children.append(c)
+    return children
+
+
+def create_daycares(daycares_dic):
+    """
+    daycares_dic に保存されたデータから CP_Daycare インスタンスのリストを作成する。
+    """
+    daycares = []
+    for d_id in daycares_dic.keys():
+        d_id = daycares_dic[d_id]["id"]
+        recruiting_numbers_list = daycares_dic[d_id]["recruiting_numbers_list"]
+        share_ages_list = daycares_dic[d_id]["share_ages_list"]
+        priority_child_id_list = daycares_dic[d_id]["priority_child_id_list"]
+        priority_score_list = daycares_dic[d_id]["priority_score_list"]
+
+        # update April 13, 2024
+        if "is_use_transfer" in daycares_dic[d_id].keys():
+            is_use_transfer = daycares_dic[d_id]["is_use_transfer"]
+        else:
+            is_use_transfer = [True, True, True, True, True, True]
+
+        # create a CP_Daycare instance
+        d = CP_Daycare(
+            d_id,
+            recruiting_numbers_list,
+            share_ages_list,
+            priority_child_id_list,
+            priority_score_list,
+            is_use_transfer,
+        )
+        daycares.append(d)
+
+    # create a dummy daycare for being unmatched
+    dummy_id = UNMATCHED_DAYCARE_ID
+    recruiting_numbers_list = [9999 for i in range(6)]  # large capacity (not a daycare ID)
+    share_ages_list = []
+    priority_child_id_list = []
+    priority_score_list = []
+    is_use_transfer = [True, True, True, True, True, True]
+    dummy = CP_Daycare(
+        dummy_id,
+        recruiting_numbers_list,
+        share_ages_list,
+        priority_child_id_list,
+        priority_score_list,
+        is_use_transfer,
+    )
+    daycares.append(dummy)
+    return daycares
+
+
+def create_families(families_dic):
+    """
+    families_dic に保存されたデータから CP_Family インスタンスのリストを作成する。
+    """
+    families = []
+    for f_id in families_dic.keys():
+        f_id = families_dic[f_id]["id"]
+        children_id_list = families_dic[f_id]["children"]
+        pref_list = families_dic[f_id]["pref"]
+        assignment = None
+        # create a CP_Family instance
+        f = CP_Family(f_id, children_id_list, pref_list, assignment)
+        families.append(f)
+    return families
+
+
+def update_families_attributes(families):
+    """
+    単独児世帯について、以下を適用する。
+        1) f.pref: list[int] を f.pref: list[tuple(int)] に変換する
+        2) None を UNMATCHED_DAYCARE_ID に変換する
+    """
+    for f in families:
+        if f.has_siblings is False:
+            f.pref = [tuple([d_id]) for d_id in f.pref]
+        for pos in range(len(f.pref)):
+            new = []
+            tup_p = f.pref[pos]
+            for item in tup_p:
+                if item is None:
+                    new.append(UNMATCHED_DAYCARE_ID)
+                else:
+                    new.append(item)
+            f.pref[pos] = tuple(new)
+
+
+def update_children_attributes(children, families):
+    """
+    1) f.pref から c.projected_pref を作る
+    2) c.projected_pref から c.all_daycare_ids を計算する
+    """
+    # update c.projected_pref
+    for f in families:
+        for pos in range(len(f.pref)):
+            tup_p = f.pref[pos]
+            for index, d_id in enumerate(tup_p):
+                f_c = get_agent(f.children[index], children)
+                f_c.projected_pref.append(tup_p[index])
+    # update c.all_daycare_ids
+    for c in children:
+        c_d_ids = []
+        for d_id in c.projected_pref:
+            if d_id not in c_d_ids:
+                c_d_ids.append(d_id)
+        c.all_daycare_ids = c_d_ids
+
+
+def update_daycares_attributes(children, daycares):
+    """
+    1) ダミー保育所（UNMATCHED_DAYCARE_ID）の優先順位・スコアリストを更新する
+    2) d.priority_age_dic と d.priority_age_share_dic を更新する
+    3) d.total_numbers と d.total_numbers_share を更新する
+    """
+    # update dummy.priority
+    dummy = get_agent(UNMATCHED_DAYCARE_ID, daycares)
+    for c in children:
+        if UNMATCHED_DAYCARE_ID in c.projected_pref and c.id not in dummy.priority:
+            dummy.priority.append(c.id)
+
+    # update dummy.score_list
+    dummy.score_list = [100 for x in range(len(dummy.priority))]
+
+    # update d.priority_age_dic & d.priority_age_share_dic
+    for d in daycares:
+        d.update_priority_age_dic(children)
+        d.update_priority_age_share_dic(children)
+
+    # update d.total_numbers
+    # 在園児が転園アウトすると枠が空くため、在園先の定員へ加算する。
+    # use_transfer[age] が False の年齢は空いた枠を再配分しないので加算しない。
+    for c in children:
+        initial = get_agent(c.initial_daycare, daycares)
+        if initial.use_transfer[c.age] is True:
+            initial.total_numbers[c.age] += 1
+
+    # update d.total_numbers_share
+    for d in daycares:
+        d.total_numbers_share = [x for x in d.total_numbers]
+        if len(d.all_shared_ages) > 0:
+            for ages in d.share_ages_list:
+                quota_ages = 0
+                for age in ages:
+                    quota_ages += d.total_numbers[age]
+                for age in ages:
+                    d.total_numbers_share[age] = quota_ages
+
+
+def create_agents(children_dic, daycares_dic, families_dic):
+    """
+    以下の関数呼び出し順序を変更しないこと。
+    """
+    children = create_children(children_dic)
+    daycares = create_daycares(daycares_dic)
+    families = create_families(families_dic)
+    update_families_attributes(families)
+    update_children_attributes(children, families)
+    update_daycares_attributes(children, daycares)
+    return children, daycares, families
+
+
+def check_IR(children):
+    non_IR_children = []
+    for c in children:
+        if c.initial_daycare != UNMATCHED_DAYCARE_ID and c.assigned_daycare == UNMATCHED_DAYCARE_ID:
+            non_IR_children.append(c.id)
+
+    if len(non_IR_children) == 0:
+        logger.debug("the outcome satisfies IR")
+    else:
+        logger.debug("the outcome does not satisfy IR")
+
+    return non_IR_children
+
+
+# NOT modified yet 2024.04.25
+def check_feasibility(children, daycares, share_bool):
+    infeasible_daycare_ids = []
+
+    # number of matched children by age
+    outcome_daycares = {}
+    for d in daycares:
+        outcome_daycares[d.id] = [0 for g in range(6)]
+    for c in children:
+        if c.assigned_daycare is not None:
+            outcome_daycares[c.assigned_daycare][c.age] += 1
+
+    # check feasibility
+    if share_bool is False:
+        for d in daycares:
+            for g in range(6):
+                if outcome_daycares[d.id][g] > d.total_numbers[g] and d.id not in infeasible_daycare_ids:
+                    infeasible_daycare_ids.append(d.id)
+    else:
+        for d in daycares:
+            for g in range(6):
+                if g in d.all_shared_ages:
+                    related_ages = d.return_related_ages(g)
+                    sum_matched = 0
+                    for x in related_ages:
+                        sum_matched += outcome_daycares[d.id][x]
+
+                    if sum_matched > d.total_numbers_share[g] and d.id not in infeasible_daycare_ids:
+                        infeasible_daycare_ids.append(d.id)
+                else:
+                    if (
+                        outcome_daycares[d.id][g] > d.total_numbers[g]
+                        and d.id not in infeasible_daycare_ids
+                    ):
+                        infeasible_daycare_ids.append(d.id)
+
+    if len(infeasible_daycare_ids) == 0:
+        logger.debug("the outcome is feasible")
+    else:
+        logger.debug("the outcome is NOT feasible")
+
+    return infeasible_daycare_ids
+
+
+# NOT modified yet 2024.04.25
+def check_bp(children_dic, daycares_dic, families_dic, outcome_f):
+    # create CP_agents
+    children, daycares, families = create_agents(children_dic, daycares_dic, families_dic)
+
+    # update f.assignment & c.assigned_dacayre
+    for f in families:
+        for p in range(len(f.pref)):
+            # 注意： outcome_f　は重要だ！！！
+            if outcome_f[f.id, p] == 1:
+                f.assignment = p
+
+                for cid in f.children:
+                    c = get_agent(cid, children)
+                    c.assigned_daycare = c.projected_pref[p]
+
+        if f.assignment is None:
+            f.assignment = len(f.pref)
+
+    # blocking coalition
+    bp_dic = {}
+    for f in families:
+        bp_dic[f.id] = []
+
+    for f in families:
+        # ignore all families who are matched to their top choice
+        if f.assignment != 0:
+            # check every position prior to f.assignment
+            for p in range(f.assignment):
+                # D(f, p)
+                D_fp = f.return_daycare_id_for_certain_position(p)
+                bool_all = 0
+
+                for d in D_fp:
+                    # default all 0 (could accept C_fpd)
+                    bool_fpd = [0 for i in range(6)]
+                    # C(f,p,d)
+                    f.return_children_for_certain_position_and_daycare(p, d)
+                    for g in range(6):
+                        # C(f,p,d,g)
+                        C_fpdg = f.return_siblings_for_certain_position_daycare_age(
+                            p, d, g, False, children, daycares
+                        )
+                        if len(C_fpdg) != 0:
+                            w_fpd = f.return_lowest_sibling_for_certain_position_daycare_age(
+                                p, d, g, False, children, daycares
+                            )
+                            daycare = get_agent(d, daycares)
+                            better_cid = daycare.return_weak_better_children_than_child_excluding_siblings(
+                                w_fpd, children, False, True, 0
+                            )
+                            better_number = 0
+                            for x in better_cid:
+                                xc = get_agent(x, children)
+                                if xc.assigned_daycare == d:
+                                    better_number += 1
+
+                            # CP モデルの定員制約と check_feasibility に合わせ、転園アウト
+                            # 込みの total_numbers を閾値にする。
+                            if better_number + len(C_fpdg) > daycare.total_numbers[g]:
+                                bool_fpd[g] = 1
+
+                    if sum(bool_fpd) == 0:
+                        bool_all += 1
+
+                if bool_all == len(D_fp):
+                    if p not in bp_dic[f.id]:
+                        bp_dic[f.id].append(p)
+
+    num_bp = 0
+    for key in bp_dic.keys():
+        num_bp += len(bp_dic[key])
+
+    if num_bp == 0:
+        logger.debug("the outcome is stable")
+    else:
+        logger.debug("the outcome is NOT stable")
+
+    return bp_dic
+
+
+def check_outcome(children_dic, daycares_dic, families_dic, outcome_children_dic, outcome_f, share_bool):
+    children, daycares, families = create_agents(children_dic, daycares_dic, families_dic)
+
+    for c in children:
+        c.assigned_daycare = outcome_children_dic[c.id]["CP"]
+
+    non_IR_children = check_IR(children)
+    infeasible_daycare_ids = check_feasibility(children, daycares, share_bool)
+    bp_dic = check_bp(children_dic, daycares_dic, families_dic, outcome_f)
+
+    return non_IR_children, infeasible_daycare_ids, bp_dic

chilmai/constants.py

@@ -0,0 +1,3 @@
+# Sentinel value for "unmatched" dummy daycare.
+# Negative so it can never collide with a real daycare ID (positive integers only).
+UNMATCHED_DAYCARE_ID = -1

chilmai/generic/__init__.py

@@ -0,0 +1,7 @@
+"""Generic municipality matching package."""
+
+from chilmai.generic.config import ConfigStore
+from chilmai.generic.preprocessor import BasePreprocessor
+from chilmai.generic.service import MatchingService
+
+__all__ = ["ConfigStore", "MatchingService", "BasePreprocessor"]

chilmai/generic/column_aliases.json

@@ -0,0 +1,214 @@
+{
+  "children": {
+    "child_id": {
+      "aliases": [
+        "申請者番号",
+        "申請者ID",
+        "申請ID",
+        "申請者No",
+        "申請No",
+        "申込者番号",
+        "申込者ID",
+        "申込番号",
+        "申請書番号",
+        "受付番号",
+        "受付No",
+        "管理番号",
+        "整理番号",
+        "ケースNo",
+        "利用者番号",
+        "児童ID",
+        "児童番号",
+        "子ども番号"
+      ]
+    },
+    "household_id": {
+      "aliases": [
+        "世帯番号",
+        "世帯ID",
+        "世帯No",
+        "世帯コード",
+        "家族番号",
+        "家族ID",
+        "保護者番号",
+        "保護者ID",
+        "世帯主番号"
+      ]
+    },
+    "age": {
+      "aliases": [
+        "年齢",
+        "年齢区分",
+        "クラス年齢",
+        "入所時年齢",
+        "入所希望年齢",
+        "入所予定年齢",
+        "申請年齢",
+        "保育年齢"
+      ]
+    },
+    "score": {
+      "aliases": [
+        "点数",
+        "スコア",
+        "指数",
+        "score",
+        "優先点",
+        "選考指数",
+        "調整指数",
+        "基準指数",
+        "入所指数",
+        "希望指数",
+        "ポイント"
+      ]
+    },
+    "score_prefix": {
+      "templates": [
+        "指数N",
+        "スコアN",
+        "score_N",
+        "第N希望点数",
+        "第N希望スコア",
+        "第N希望指数",
+        "N希望指数",
+        "N希望点数",
+        "選考指数N",
+        "調整指数N",
+        "基準指数N",
+        "入所指数N",
+        "点数N",
+        "優先点N",
+        "ポイントN"
+      ]
+    },
+    "preference_prefix": {
+      "templates": [
+        "希望保育園ID_N",
+        "希望保育所ID_N",
+        "希望施設ID_N",
+        "第N希望保育園",
+        "第N希望保育所",
+        "第N希望施設",
+        "第N希望施設ID",
+        "第N希望園",
+        "N番目希望",
+        "希望N",
+        "pref_N"
+      ]
+    },
+    "enrolled_daycare_id": {
+      "aliases": [
+        "在籍保育所ID",
+        "在籍保育園ID",
+        "在籍施設ID",
+        "在籍園ID",
+        "転園元保育所ID",
+        "転園元保育園ID",
+        "転園元施設ID",
+        "転園元園ID",
+        "現保育所ID",
+        "現在の保育所ID",
+        "現在の施設ID",
+        "現在の園ID",
+        "在園保育所ID",
+        "通園中保育所ID"
+      ]
+    },
+    "sibling_pattern": {
+      "aliases": [
+        "きょうだいパターン",
+        "兄弟姉妹パターン",
+        "兄弟パターン",
+        "きょうだい希望パターン",
+        "兄弟入所区分",
+        "きょうだい申請区分",
+        "多子申請区分",
+        "同時申請区分"
+      ]
+    }
+  },
+  "daycares": {
+    "daycare_id": {
+      "aliases": [
+        "保育所ID",
+        "保育園ID",
+        "施設ID",
+        "園ID",
+        "保育所コード",
+        "保育園コード",
+        "施設コード",
+        "園コード",
+        "保育所番号",
+        "施設番号",
+        "園番号",
+        "保育所管理番号",
+        "施設管理番号"
+      ]
+    },
+    "daycare_name": {
+      "aliases": [
+        "保育所名",
+        "保育園名",
+        "施設名",
+        "園名",
+        "保育所名称",
+        "保育園名称",
+        "施設名称",
+        "園名称",
+        "施設正式名称",
+        "認可施設名"
+      ]
+    },
+    "capacity_prefix": {
+      "templates": [
+        "N歳募集人数",
+        "N歳定員",
+        "N歳児定員",
+        "N歳児募集人数",
+        "N歳クラス定員",
+        "N歳クラス募集人数",
+        "N歳受入可能数",
+        "定員N歳",
+        "定員N歳枠",
+        "募集人数N",
+        "capacity_age_N",
+        "capacity_ageN"
+      ]
+    }
+  },
+  "combination": {
+    "household_id": {
+      "aliases": [
+        "ファミリーコード",
+        "家族コード",
+        "世帯コード",
+        "世帯番号",
+        "世帯ID"
+      ]
+    },
+    "rank": {
+      "aliases": [
+        "総当たり順位",
+        "組み合わせ順位",
+        "希望順位",
+        "組合せ順位"
+      ]
+    },
+    "child_code_prefix": {
+      "templates": [
+        "宛名コードN",
+        "児童コードN",
+        "申請者コードN",
+        "子どもコードN"
+      ]
+    },
+    "facility_prefix": {
+      "templates": [
+        "希望施設N",
+        "希望保育所N",
+        "希望保育園N",
+        "施設コードN"
+      ]
+    }
+  }
+}