Merge in main

Author: justino599

.gitignore

@@ -16,3 +16,6 @@ env/.env*
 
 # Nginx
 logs/nginx/
+
+# Local database
+.data/

.gitmodules

@@ -1,3 +1,6 @@
-[submodule "api/ai/group_matcher_algorithm/group-matcher"]
-	path = api/ai/group_matcher_algorithm/group-matcher
+[submodule "simulation_cache"]
+    path = simulation_cache
+    url = https://github.com/Teamable-Analytics/algorithms-simulation-cache.git
+[submodule "api/ai/external_algorithms/group_matcher_algorithm/group-matcher"]
+	path = api/ai/external_algorithms/group_matcher_algorithm/group-matcher
 	url = https://github.com/ketphan02/group-matcher.git

README.md

@@ -16,7 +16,11 @@
    ```
    python3 -m pip install -r requirements.txt
    ```
-3. You're good to go!
+3. Initialize submodules.
+   ```
+   git submodule update --init --recursive
+   ```
+4. You're good to go!
    > Be sure to read any directory-specific README.md and CONVENTION.md files before starting to work.
 
 ### Metrics
@@ -50,7 +54,7 @@ python3 -m unittest discover tests
 - todo: the logic for each of our algorithms
 - todo: the api that serves these algorithms
 
-#### /models
+#### /dataclasses
 
 - dataclasses, types, and enums used in the rest of the repository
 

api/ai/algorithm_runner.py

@@ -1,5 +1,8 @@
 from typing import List, TYPE_CHECKING
 
+from api.ai.external_algorithms.group_matcher_algorithm.group_matcher_algorithm import (
+    GroupMatcherAlgorithm,
+)
 from api.ai.geg_algorithm.geg_algorithm import GeneralizedEnvyGraphAlgorithm
 from api.ai.interfaces.algorithm_config import (
     AlgorithmConfig,
@@ -30,10 +33,9 @@
 from api.ai.double_round_robin_algorithm.double_round_robin_algorithm import (
     DoubleRoundRobinAlgorithm,
 )
-from api.ai.group_matcher_algorithm.group_matcher_algorithm import GroupMatcherAlgorithm
-from api.models.enums import AlgorithmType
-from api.models.student import Student
-from api.models.team_set import TeamSet
+from api.dataclasses.enums import AlgorithmType
+from api.dataclasses.student import Student
+from api.dataclasses.team_set import TeamSet
 
 if TYPE_CHECKING:
     from api.ai.interfaces.algorithm_options import AlgorithmOptions

…e_round_robin_algorithm/custom_models.py …nd_robin_algorithm/custom_dataclasses.pyapi/ai/double_round_robin_algorithm/custom_models.py renamed to api/ai/double_round_robin_algorithm/custom_dataclasses.py api/ai/double_round_robin_algorithm/custom_models.py renamed to api/ai/double_round_robin_algorithm/custom_dataclasses.py

@@ -1,4 +1,4 @@
-from api.models.student import Student
+from api.dataclasses.student import Student
 
 
 class Utility:

api/ai/double_round_robin_algorithm/double_round_robin_algorithm.py

@@ -28,14 +28,14 @@
 """
 from typing import List, Dict, Set, Callable
 
-from api.ai.double_round_robin_algorithm.custom_models import Utility
+from api.ai.double_round_robin_algorithm.custom_dataclasses import Utility
 from api.ai.interfaces.algorithm import Algorithm
 from api.ai.interfaces.algorithm_config import DoubleRoundRobinAlgorithmConfig
 from api.ai.interfaces.algorithm_options import DoubleRoundRobinAlgorithmOptions
 from api.ai.interfaces.team_generation_options import TeamGenerationOptions
-from api.models.student import Student
-from api.models.team import Team, TeamShell
-from api.models.team_set import TeamSet
+from api.dataclasses.student import Student
+from api.dataclasses.team import Team, TeamShell
+from api.dataclasses.team_set import TeamSet
 
 
 class DoubleRoundRobinAlgorithm(Algorithm):

api/models/__init__.py api/ai/external_algorithms/__init__.pyapi/models/__init__.py renamed to api/ai/external_algorithms/__init__.py

@@ -0,0 +1,90 @@
+from dataclasses import dataclass
+from typing import Dict, Iterator
+
+import faker
+from pandas import DataFrame
+
+from api.ai.external_algorithms.group_matcher_algorithm.utils import (
+    fromYearLevelToAlYearLevel,
+    fromNumbersToTimeSlots,
+    fromGenderToAlGender,
+    fromRaceToAlRace,
+)
+from api.dataclasses.enums import ScenarioAttribute, Gender, Race
+from api.dataclasses.student import Student
+from api.dataclasses.team import Team
+from api.dataclasses.team_set import TeamSet
+
+
+@dataclass
+class GroupMatcherStudent(Student):
+    def __init__(self, student: Student):
+        super().__init__(
+            student.id,
+            student.name,
+            student.attributes,
+            student.relationships,
+            student.project_preferences,
+            student.team,
+        )
+        self.email = faker.Faker().email()
+        if not self.name:
+            self.name = faker.Faker().name()
+
+    def get_formatted_data(self):
+        return {
+            "Email Address": self.email,
+            "SID": self.id,
+            "First name": self.name.split()[0],
+            "Last name": self.name.split()[1],
+            "What year are you": fromYearLevelToAlYearLevel(
+                self.attributes[ScenarioAttribute.YEAR_LEVEL.value][0]
+            ).value,
+            "Would you like to be part of a course study group?": "Yes",
+            "Do you have an existing study group of size 2-6 in mind": "No",
+            "timezone offset": "-7",  # all the same timezone
+            "Would you like to attend the same discussion": "Yes",
+            "discussion section times": fromNumbersToTimeSlots(
+                self.attributes.get(
+                    ScenarioAttribute.TIMESLOT_AVAILABILITY.value, ["1"]
+                )
+            ),
+            "Will you be on the Berkeley campus": "Yes",  # No remote students
+            "Which of these options best describes your race?": fromRaceToAlRace(
+                Race(self.attributes.get(ScenarioAttribute.RACE.value, [Race.Other])[0])
+            ).value,
+            "How do you self-identify?": fromGenderToAlGender(
+                Gender(self.attributes[ScenarioAttribute.GENDER.value][0])
+            ).value,
+        }
+
+    @staticmethod
+    def transform_output_data_to_team_set(
+        output_data: DataFrame,
+        team_trace: Dict[int, Team],
+        student_trace: Dict[int, Student],
+        team_cycler: Iterator[Team],
+    ) -> TeamSet:
+        for _, row in output_data.iterrows():
+            student_id = row["sid"]
+            group_num = int(row["group_num"]) + 1
+            if group_num not in team_trace.keys():
+                new_team_attributes = next(team_cycler)
+                new_team = Team(
+                    _id=len(team_trace) + 1,
+                    name=f"Team {len(team_trace) + 1}",
+                    requirements=new_team_attributes.requirements,
+                    project_id=new_team_attributes.project_id,
+                    students=[],
+                )
+                team_trace[int(row["group_num"]) + 1] = new_team
+
+            student = student_trace[student_id]
+            team = team_trace[int(row["group_num"]) + 1]
+
+            student.add_team(team)
+            team.add_student(student)
+
+        return TeamSet(
+            teams=[team for team in team_trace.values() if len(team.students) > 0]
+        )