Merge pull request #315 from c-bata/interface-change-for-set-study-directions

Interface change for set study directions

optuna_dashboard/_app.py

@@ -159,6 +159,19 @@ def get_study_summary(storage: BaseStorage, study_id: int) -> Optional[StudySumm
     return None
 
 
+def create_new_study(
+    storage: BaseStorage, study_name: str, directions: List[StudyDirection]
+) -> int:
+    if version.parse(optuna_ver) >= version.Version("3.1.0.dev") and version.parse(
+        optuna_ver
+    ) != version.Version("3.1.0b0"):
+        study_id = storage.create_new_study(directions, study_name=study_name)  # type: ignore
+    else:
+        study_id = storage.create_new_study(study_name)  # type: ignore
+        storage.set_study_directions(study_id, directions)  # type: ignore
+    return study_id
+
+
 def get_trials(storage: BaseStorage, study_id: int, ttl_seconds: int = 10) -> List[FrozenTrial]:
     with trials_cache_lock:
         trials = trials_cache.get(study_id, None)
@@ -241,29 +254,25 @@ def create_app(storage: BaseStorage, debug: bool = False) -> Bottle:
     @json_api_view
     def create_study() -> BottleViewReturn:
         study_name = request.json.get("study_name", None)
-        directions = request.json.get("directions", [])
+        request_directions = [d.lower() for d in request.json.get("directions", [])]
         if (
             study_name is None
-            or len(directions) == 0
-            or not all([d in ("minimize", "maximize") for d in directions])
+            or len(request_directions) == 0
+            or not all([d in ("minimize", "maximize") for d in request_directions])
         ):
             response.status = 400  # Bad request
             return {"reason": "You need to set study_name and direction"}
 
+        directions = [
+            StudyDirection.MAXIMIZE if d == "maximize" else StudyDirection.MINIMIZE
+            for d in request_directions
+        ]
         try:
-            study_id = storage.create_new_study(study_name)
+            study_id = create_new_study(storage, study_name, directions)
         except DuplicatedStudyError:
             response.status = 400  # Bad request
             return {"reason": f"'{study_name}' already exists"}
 
-        storage.set_study_directions(
-            study_id,
-            [
-                StudyDirection.MAXIMIZE if d.lower() == "maximize" else StudyDirection.MINIMIZE
-                for d in directions
-            ],
-        )
-
         summary = get_study_summary(storage, study_id)
         if summary is None:
             response.status = 500  # Internal server error

python_tests/test_api.py

@@ -3,7 +3,9 @@ from unittest import TestCase
 
 import optuna
 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 .wsgi_client import send_request
 
@@ -16,8 +18,8 @@ def objective(trial: optuna.trial.Trial) -> float:
 class APITestCase(TestCase):
     def test_get_study_summaries(self) -> None:
         storage = optuna.storages.InMemoryStorage()
-        storage.create_new_study("foo1")
-        storage.create_new_study("foo2")
+        create_new_study(storage, "foo1", [StudyDirection.MINIMIZE])
+        create_new_study(storage, "foo2", [StudyDirection.MINIMIZE])
 
         app = create_app(storage)
         status, _, body = send_request(
@@ -126,7 +128,7 @@ class APITestCase(TestCase):
 
     def test_create_study_duplicated(self) -> None:
         storage = optuna.storages.InMemoryStorage()
-        storage.create_new_study("foo")
+        create_new_study(storage, "foo", [StudyDirection.MINIMIZE])
         self.assertEqual(len(get_all_study_summaries(storage)), 1)
 
         app = create_app(storage)
@@ -146,8 +148,8 @@ class APITestCase(TestCase):
 
     def test_delete_study(self) -> None:
         storage = optuna.storages.InMemoryStorage()
-        storage.create_new_study("foo1")
-        storage.create_new_study("foo2")
+        create_new_study(storage, "foo1", [StudyDirection.MINIMIZE])
+        create_new_study(storage, "foo2", [StudyDirection.MINIMIZE])
         self.assertEqual(len(get_all_study_summaries(storage)), 2)
 
         app = create_app(storage)