Feature: Add 5 new member activity analysis

setup.py

@@ -6,7 +6,7 @@
 
 setup(
     name="tc-core-analyzer-lib",
-    version="1.0.2",
+    version="1.1.0",
     author="Mohammad Amin Dadgar, TogetherCrew",
     maintainer="Mohammad Amin Dadgar",
     maintainer_email="[email protected]",

tc_core_analyzer_lib/assess_engagement.py

@@ -15,6 +15,7 @@
     assess_remainder,
     assess_still_active,
     assess_vital,
+    assess_inconsistent,
 )
 from .utils.compute_interaction_per_acc import thr_int
 
@@ -74,6 +75,11 @@ def compute(
         all_lurker,
         all_about_to_disengage,
         all_disengaged_in_past,
+        all_inconsistent,
+        all_new_consistent,
+        all_new_vital,
+        all_became_not_consistent,
+        all_became_unvital,
     ):
         """
         Assess engagment levels for all active members in a time period
@@ -233,6 +239,11 @@ def compute(
             all_paused[str(w_i)] - all_consistent[str(w_i)]
         )
 
+        # # # INCONSISTENT
+        all_inconsistent[str(w_i)] = assess_inconsistent(
+            all_active, all_paused, all_new_active, all_consistent, w_i
+        )
+
         # # # SUBDIVIDE DISENGAGED TYPES # # #
 
         # make temporary dictionary for remaining disengaged members
@@ -270,6 +281,26 @@ def compute(
             all_disengaged_were_consistently_active[str(w_i)] = set()
             all_disengaged_were_newly_active[str(w_i)] = set()
 
+        # # # DETECT CHANGES SINCE LAST PERIOD # # #
+        if w_i - WINDOW_D >= 0:
+            all_new_consistent[str(w_i)] = (
+                all_consistent[str(w_i)] - all_consistent[str(w_i - WINDOW_D)]
+            )
+            all_new_vital[str(w_i)] = (
+                all_vital[str(w_i)] - all_vital[str(w_i - WINDOW_D)]
+            )
+            all_became_not_consistent[str(w_i)] = (
+                all_consistent[str(w_i - WINDOW_D)] - all_consistent[str(w_i)]
+            )
+            all_became_unvital[str(w_i)] = (
+                all_vital[str(w_i - WINDOW_D)] - all_vital[str(w_i)]
+            )
+        else:
+            all_new_consistent[str(w_i)] = set()
+            all_new_vital[str(w_i)] = set()
+            all_became_not_consistent[str(w_i)] = set()
+            all_became_unvital[str(w_i)] = set()
+
         return (
             graph,
             all_joined,
@@ -292,4 +323,9 @@ def compute(
             all_lurker,
             all_about_to_disengage,
             all_disengaged_in_past,
+            all_inconsistent,
+            all_new_consistent,
+            all_new_vital,
+            all_became_not_consistent,
+            all_became_unvital,
         )

tc_core_analyzer_lib/tests/integration/test_active_members.py

@@ -38,6 +38,11 @@ def test_no_active():
         "all_lurker": {},
         "all_about_to_disengage": {},
         "all_disengaged_in_past": {},
+        "all_inconsistent": {},
+        "all_new_consistent": {},
+        "all_new_vital": {},
+        "all_became_not_consistent": {},
+        "all_became_unvital": {},
     }
 
     WINDOW_D = 7
@@ -160,6 +165,11 @@ def test_single_active():
         "all_lurker": {},
         "all_about_to_disengage": {},
         "all_disengaged_in_past": {},
+        "all_inconsistent": {},
+        "all_new_consistent": {},
+        "all_new_vital": {},
+        "all_became_not_consistent": {},
+        "all_became_unvital": {},
     }
     # time window
     WINDOW_D = 7

tc_core_analyzer_lib/tests/integration/test_all_active_fourteen_period.py

@@ -72,6 +72,11 @@ def test_all_active_fourteen_period():
         "all_lurker": {},
         "all_about_to_disengage": {},
         "all_disengaged_in_past": {},
+        "all_inconsistent": {},
+        "all_new_consistent": {},
+        "all_new_vital": {},
+        "all_became_not_consistent": {},
+        "all_became_unvital": {},
     }
 
     WINDOW_D = 7

tc_core_analyzer_lib/tests/integration/test_all_became_not_consistent.py

@@ -0,0 +1,165 @@
+# test all_active members using the interaction matrix
+import numpy as np
+from tc_core_analyzer_lib.assess_engagement import EngagementAssessment
+from tc_core_analyzer_lib.utils.activity import DiscordActivity
+
+
+def test_became_not_consistent():
+    acc_names = []
+    acc_count = 10
+
+    INT_THR = 1  # minimum number of interactions to be active
+    UW_DEG_THR = 1  # minimum number of accounts interacted with to be active
+    PAUSED_T_THR = 1  # time period to remain paused
+    CON_T_THR = 4  # time period to be consistent active
+    CON_O_THR = 3  # time period to be consistent active
+    EDGE_STR_THR = 5  # minimum number of interactions for connected
+    UW_THR_DEG_THR = 5  # minimum number of accounts for connected
+    VITAL_T_THR = 4  # time period to assess for vital
+    VITAL_O_THR = 3  # times to be connected within VITAL_T_THR to be vital
+    STILL_T_THR = 2  # time period to assess for still active
+    STILL_O_THR = 2  # times to be active within STILL_T_THR to be still active
+    # time periods into the past (history) to be newly active for computing dropped
+    DROP_H_THR = 2
+    # consecutive time periods into the past to have not been active for computing
+    DROP_I_THR = 1
+
+    act_param = [
+        INT_THR,
+        UW_DEG_THR,
+        PAUSED_T_THR,
+        CON_T_THR,
+        CON_O_THR,
+        EDGE_STR_THR,
+        UW_THR_DEG_THR,
+        VITAL_T_THR,
+        VITAL_O_THR,
+        STILL_T_THR,
+        STILL_O_THR,
+        DROP_H_THR,
+        DROP_I_THR,
+    ]
+
+    for i in range(acc_count):
+        acc_names.append(f"user{i}")
+
+    acc_names = np.array(acc_names)
+
+    # four weeks
+    max_interval = 35
+
+    # preparing empty joined members dict
+    all_joined = dict(
+        zip(np.array(range(max_interval), dtype=str), np.repeat(set(), max_interval))
+    )
+
+    activity_dict = {
+        "all_joined": {},
+        "all_joined_day": all_joined,
+        "all_consistent": {},
+        "all_vital": {},
+        "all_active": {},
+        "all_connected": {},
+        "all_paused": {},
+        "all_new_disengaged": {},
+        "all_disengaged": {},
+        "all_unpaused": {},
+        "all_returned": {},
+        "all_new_active": {},
+        "all_still_active": {},
+        "all_dropped": {},
+        "all_disengaged_were_newly_active": {},
+        "all_disengaged_were_consistently_active": {},
+        "all_disengaged_were_vital": {},
+        "all_lurker": {},
+        "all_about_to_disengage": {},
+        "all_disengaged_in_past": {},
+        "all_inconsistent": {},
+        "all_new_consistent": {},
+        "all_new_vital": {},
+        "all_became_not_consistent": {},
+        "all_became_unvital": {},
+    }
+    memberactivites = activity_dict.keys()
+
+    int_mat = {
+        DiscordActivity.Reply: np.zeros((acc_count, acc_count)),
+        DiscordActivity.Mention: np.zeros((acc_count, acc_count)),
+        DiscordActivity.Reaction: np.zeros((acc_count, acc_count)),
+    }
+    int_mat[DiscordActivity.Reaction][0, 1] = 6
+
+    activities = [
+        DiscordActivity.Reaction,
+        DiscordActivity.Mention,
+        DiscordActivity.Reply,
+    ]
+
+    engagement = EngagementAssessment(
+        activities=activities, activities_ignore_0_axis=[], activities_ignore_1_axis=[]
+    )
+
+    # the analytics
+    for w_i in range(max_interval):
+        # time window
+        WINDOW_D = 7
+
+        (_, *activity_dict) = engagement.compute(
+            int_mat=int_mat,
+            w_i=w_i,
+            acc_names=acc_names,
+            act_param=act_param,
+            WINDOW_D=WINDOW_D,
+            **activity_dict,
+        )
+
+        if w_i == 14:
+            int_mat[DiscordActivity.Reaction][0, 1] = 0
+            int_mat[DiscordActivity.Reaction][0, 2] = 0
+            int_mat[DiscordActivity.Reaction][0, 3] = 0
+            int_mat[DiscordActivity.Reaction][0, 4] = 0
+            int_mat[DiscordActivity.Reaction][0, 5] = 0
+            int_mat[DiscordActivity.Reaction][0, 6] = 0
+
+        activity_dict = dict(zip(memberactivites, activity_dict))
+
+    print("all_consistent:", activity_dict["all_consistent"])
+    print("all_became_not_consistent:", activity_dict["all_became_not_consistent"])
+
+    assert activity_dict["all_became_not_consistent"] == {
+        "0": set(),
+        "1": set(),
+        "2": set(),
+        "3": set(),
+        "4": set(),
+        "5": set(),
+        "6": set(),
+        "7": set(),
+        "8": set(),
+        "9": set(),
+        "10": set(),
+        "11": set(),
+        "12": set(),
+        "13": set(),
+        "14": set(),
+        "15": set(),
+        "16": set(),
+        "17": set(),
+        "18": set(),
+        "19": set(),
+        "20": set(),
+        "21": set(),
+        "22": set(),
+        "23": set(),
+        "24": set(),
+        "25": set(),
+        "26": set(),
+        "27": set(),
+        "28": {"user0", "user1"},
+        "29": set(),
+        "30": set(),
+        "31": set(),
+        "32": set(),
+        "33": set(),
+        "34": set(),
+    }