[back][front] refactor: score_magnitude -> score_max

backend/tournesol/lib/public_dataset.py

@@ -52,7 +52,7 @@ def get_comparisons_data(poll_name: str, until_: datetime) -> QuerySet:
             comparisoncriteriascore.criteria,
             comparisoncriteriascore.weight,
             comparisoncriteriascore.score,
-            comparisoncriteriascore.score_magnitude,
+            comparisoncriteriascore.score_max,
             DATE(DATE_TRUNC('week', datetime_add)) AS week_date
 
         FROM tournesol_comparison
@@ -288,7 +288,7 @@ def write_comparisons_file(
         "video_b",
         "criteria",
         "score",
-        "score_magnitude",
+        "score_max",
         "week_date"
     ]
     writer = csv.DictWriter(write_target, fieldnames=fieldnames)
@@ -300,7 +300,7 @@ def write_comparisons_file(
             "video_b": comparison.uid_b.split(UID_DELIMITER)[1],
             "criteria": comparison.criteria,
             "score": int(round(comparison.score)),
-            "score_magnitude": comparison.score_magnitude,
+            "score_max": comparison.score_max,
             "week_date": comparison.week_date,
         }
         for comparison in get_comparisons_data(poll_name, until_).iterator()

backend/tournesol/management/commands/load_public_dataset.py

@@ -110,6 +110,7 @@ def handle(self, *args, **options):
                         comparison=comparison,
                         criteria=values["criteria"],
                         score=values["score"],
+                        score_max=values["score_max"],
                     )
                 nb_comparisons += 1
             print(f"Created {nb_comparisons} comparisons")

backend/tournesol/migrations/0061_comparisoncriteriascore_score_max_and_more.py

@@ -0,0 +1,29 @@
+# Generated by Django 4.2.11 on 2024-05-02 09:05
+
+import django.core.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("tournesol", "0060_remove_entity_tournesol_score"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="comparisoncriteriascore",
+            name="score_max",
+            field=models.IntegerField(
+                default=10,
+                help_text="The absolute value of the maximum score.",
+                validators=[django.core.validators.MinValueValidator(1)],
+            ),
+            preserve_default=False,
+        ),
+        migrations.AlterField(
+            model_name="comparisoncriteriascore",
+            name="score",
+            field=models.FloatField(help_text="Score for the given comparison"),
+        ),
+    ]

backend/tournesol/models/comparisons.py

@@ -129,12 +129,10 @@ class ComparisonCriteriaScore(models.Model):
     )
     score = models.FloatField(
         help_text="Score for the given comparison",
-        # TODO: remove the validators, the function save replaces them.
-        validators=[MinValueValidator(-COMPARISON_MAX), MaxValueValidator(COMPARISON_MAX)],
     )
-    score_magnitude = models.IntegerField(
+    score_max = models.IntegerField(
         help_text="The absolute value of the maximum score.",
-        default=COMPARISON_MAX,
+        validators=[MinValueValidator(1)],
     )
     # TODO: ask Lê if weights should be in a certain range (maybe always > 0)
     # and add validation if required
@@ -151,9 +149,10 @@ def __str__(self):
         return f"{self.comparison}/{self.criteria}/{self.score}"
 
     def save(self, *args, **kwargs):
-        if abs(self.score) > abs(self.score_magnitude):
-            raise ValueError(
-                f"The absolute value of the score {self.score} given to the criterion "
-                f"{self.criteria} can't be superior to the magnitude {self.score_magnitude}."
-            )
+        if self.score_max is not None:
+            if abs(self.score) > abs(self.score_max):
+                raise ValueError(
+                    f"The absolute value of the score {self.score} given to the criterion "
+                    f"{self.criteria} can't be superior to the score_max {self.score_max}."
+                )
         return super().save(*args, **kwargs)

backend/tournesol/resources/export_readme.txt

@@ -70,12 +70,12 @@ List of columns:
 
 - score:
 
-  The score is an integer in the range [-score_magnitude, +score_magnitude].
-  Negative values indicate that the user considers the video_a better, and
-  positive values indicate that they prefer the video_b. A score of 0 or close
-  to 0 means that they find the two videos similar.
+  The score is an integer in the range [-score_max, +score_max]. Negative
+  values indicate that the user considers the video_a better, and positive
+  values indicate that they prefer the video_b. A score of 0 or close to 0
+  means that they find the two videos similar.
 
-- score_magnitude:
+- score_max:
 
   The absolute value of the minimum and maximum score. 10 means the user could
   have given a score between -10 and +10 for the criterion.

backend/tournesol/serializers/comparison.py

@@ -11,7 +11,7 @@
 class ComparisonCriteriaScoreSerializer(ModelSerializer):
     class Meta:
         model = ComparisonCriteriaScore
-        fields = ["criteria", "score", "score_magnitude", "weight"]
+        fields = ["criteria", "score", "score_max", "weight"]
 
     def validate_criteria(self, value):
         current_poll = self.context["poll"]

backend/tournesol/tests/factories/comparison.py

@@ -31,3 +31,4 @@ class Meta:
     comparison = factory.SubFactory(ComparisonFactory)
     criteria = "better_habits"
     score = fuzzy.FuzzyDecimal(-10, 10)
+    score_max = 10