Merge pull request #615 from moririn2528/settting-api

add preference feedback component api

python_tests/test_api.py

@@ -8,6 +8,7 @@ from optuna import get_all_study_summaries
 from optuna.study import StudyDirection
 from optuna_dashboard._app import create_app
 from optuna_dashboard._app import create_new_study
+from optuna_dashboard._preference_setting import register_preference_feedback_component
 from optuna_dashboard._preferential_history import NewHistory
 from optuna_dashboard._preferential_history import remove_history
 from optuna_dashboard._preferential_history import report_history
@@ -183,6 +184,36 @@ class APITestCase(TestCase):
         )
         self.assertEqual(status, 400)
 
+    def test_change_component(self) -> None:
+        storage = optuna.storages.InMemoryStorage()
+        study = create_study(storage=storage, n_generate=3)
+        register_preference_feedback_component(study, "note")
+        for _ in range(3):
+            study.ask()
+
+        app = create_app(storage)
+        study_id = study._study._study_id
+        status, _, _ = send_request(
+            app,
+            f"/api/studies/{study_id}/preference_feedback_component_type",
+            "PUT",
+            body=json.dumps({"type": "artifact", "artifact_key": "image"}),
+            content_type="application/json",
+        )
+        self.assertEqual(status, 204)
+
+        status, _, body = send_request(
+            app,
+            f"/api/studies/{study_id}",
+            "GET",
+            content_type="application/json",
+        )
+        self.assertEqual(status, 200)
+
+        study_detail = json.loads(body)
+        assert study_detail["feedback_component_type"]["type"] == "artifact"
+        assert study_detail["feedback_component_type"]["artifact_key"] == "image"
+
     def test_skip_trial(self) -> None:
         storage = optuna.storages.InMemoryStorage()
         study = create_study(n_generate=4, storage=storage)

python_tests/test_preference_setting.py

@@ -0,0 +1,20 @@
+from __future__ import annotations
+
+from unittest import TestCase
+
+import optuna
+from optuna_dashboard._preference_setting import _SYSTEM_ATTR_FEEDBACK_COMPONENT
+from optuna_dashboard._preference_setting import register_preference_feedback_component
+from optuna_dashboard.preferential._study import PreferentialStudy
+
+
+class FeedbackSettingTestCase(TestCase):
+    def test_widget_to_dict_from_dict(self) -> None:
+        study = PreferentialStudy(optuna.create_study())
+        register_preference_feedback_component(study, "artifact", "image_key")
+        system_attrs = study._study.system_attrs
+        feedback_type = system_attrs.get(_SYSTEM_ATTR_FEEDBACK_COMPONENT, {})
+        assert "type" in feedback_type
+        assert feedback_type["type"] == "artifact"
+        assert "artifact_key" in feedback_type
+        assert feedback_type["artifact_key"] == "image_key"