jcmoptimizer 3.0.0__tar.gz → 3.0.2__tar.gz

{jcmoptimizer-3.0.0 → jcmoptimizer-3.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jcmoptimizer
-Version: 3.0.0
+Version: 3.0.2
 Summary: The JCMoptimizer interface for Python
 Author-email: Philipp Schneider <philipp.schneider@jcmwave.com>
 License-Expression: MIT
@@ -20,16 +20,23 @@ Dynamic: license-file
 
 This package implements a python client for interacting with the JCMoptimizer server. It provides a convenient interface to set up, run, and analyze numerical studies of expensive black box functions.
 
-## Getting Started ##
+## Getting Started
 
-You need install JCMsuite and the JCMoptimizer extension for JCMsuite:
-* Browse to the [JCMsuite download](https://installation.jcmwave.com/fb13885794fc64c42531c9656f8f6f73.php) page to install JCMsuite and to retrieve a demo or commercial license.
-* Browse to the [JCMoptimizer download](https://optimizer.jcmwave.com/download-jcmoptimizer) page to install JCMoptimzizer.
+### Cloud Service
+The easiest way to get started is to use the free tier of the JCMwave's cloud service for JCMoptimizer:
 * Install the `jcmoptimizer` package into your python environmentm, e.g. by runing `pip install jcmoptimizer`.
+* Signup to [optimizer.jcmwave.com](https://optimizer.jcmwave.com).
+* Create an [API access token](https://optimizer.jcmwave.com/cloud/tokens/list/)
+
+### Run JCMoptimizer Locally
+For a self-hosted version, you need install JCMsuite and the JCMoptimizer extension for JCMsuite:
+* Browse to the [JCMsuite download](https://installation.jcmwave.com/fb13885794fc64c42531c9656f8f6f73.php) page to install JCMsuite and to retrieve a demo or commercial license.
+* Browse to the [JCMoptimizer download](https://optimizer.jcmwave.com/download) page to install JCMoptimzizer.
 
+### First Example
 A basic usage example of the python package is given in the tutorial on a [Bayesian Optimization](https://optimizer.jcmwave.com/documentation/python/latest/tutorials/vanilla_bayesian_optimization.html).
 
-## Documentation ##
+## Documentation
 
 For a comprehensive overview of all available classes, methods, and their parameters, please refer to the official JCMoptimizer Python documentation:
 

{jcmoptimizer-3.0.0 → jcmoptimizer-3.0.2}/README.md

@@ -2,16 +2,23 @@
 
 This package implements a python client for interacting with the JCMoptimizer server. It provides a convenient interface to set up, run, and analyze numerical studies of expensive black box functions.
 
-## Getting Started ##
+## Getting Started
 
-You need install JCMsuite and the JCMoptimizer extension for JCMsuite:
-* Browse to the [JCMsuite download](https://installation.jcmwave.com/fb13885794fc64c42531c9656f8f6f73.php) page to install JCMsuite and to retrieve a demo or commercial license.
-* Browse to the [JCMoptimizer download](https://optimizer.jcmwave.com/download-jcmoptimizer) page to install JCMoptimzizer.
+### Cloud Service
+The easiest way to get started is to use the free tier of the JCMwave's cloud service for JCMoptimizer:
 * Install the `jcmoptimizer` package into your python environmentm, e.g. by runing `pip install jcmoptimizer`.
+* Signup to [optimizer.jcmwave.com](https://optimizer.jcmwave.com).
+* Create an [API access token](https://optimizer.jcmwave.com/cloud/tokens/list/)
+
+### Run JCMoptimizer Locally
+For a self-hosted version, you need install JCMsuite and the JCMoptimizer extension for JCMsuite:
+* Browse to the [JCMsuite download](https://installation.jcmwave.com/fb13885794fc64c42531c9656f8f6f73.php) page to install JCMsuite and to retrieve a demo or commercial license.
+* Browse to the [JCMoptimizer download](https://optimizer.jcmwave.com/download) page to install JCMoptimzizer.
 
+### First Example
 A basic usage example of the python package is given in the tutorial on a [Bayesian Optimization](https://optimizer.jcmwave.com/documentation/python/latest/tutorials/vanilla_bayesian_optimization.html).
 
-## Documentation ##
+## Documentation
 
 For a comprehensive overview of all available classes, methods, and their parameters, please refer to the official JCMoptimizer Python documentation:
 

{jcmoptimizer-3.0.0 → jcmoptimizer-3.0.2}/jcmoptimizer/client.py

@@ -1,5 +1,5 @@
 from typing import Optional, Any
-from datetime import datetime
+from datetime import datetime, timedelta
 import webbrowser
 from .requestor import (
     OptimizerRequestor,
@@ -33,6 +33,13 @@ class Client:
           For example, for a local server ``'http://localhost:4554'``
       server_id: If the host is unkown, a cloud server can be accessed by its
           server ID.
+
+          .. note:: If both `host` and `server_id` are not specified,
+             the client first tries to connects to a running cloud server.
+             If not possible, the client starts a new
+             :class:`~jcmoptimizer.Server` instance
+             with default setting and connects to it.
+
       token: API access token. This is required for cloud servers.
           In order to create a token, visit the
           `JCMoptimizer Cloud <https://optimizer.jcmwave.com/cloud/tokens/list>`_
@@ -58,23 +65,49 @@ class Client:
 
         if token is None:
             token = self.config.get("token", None)
-            
+
         if host is None:
-            # get host from cloud api
-            if server_id is None:
-                raise ValueError("Either 'host' or 'server_id' must be set")
-
-            if token is None:
-                raise ValueError("Argument 'token' must be set if 'host' is unkown")
-            
-            cloud_requestor = CloudRequestor(cloud_endpoint, token)
-            r = cloud_requestor.request("GET", "get server url", f"servers/{server_id}/")
-            data = r.json()
-            host = data["url"]
+            from .server import _wait_for_server_startup
+
+            if server_id is not None:
+                if token is None:
+                    raise ValueError(
+                        "If server_id is specified, "
+                        "the token must be specified as well."
+                    )
+                # get host from cloud api
+                cloud_requestor = CloudRequestor(cloud_endpoint, token)
+                r = cloud_requestor.request(
+                    "GET", "get server url", f"servers/{server_id}/"
+                )
+                data = r.json()
+                host = data["url"]
+                _wait_for_server_startup(cloud_endpoint, token, server_id, host)
+
+            if host is None:
+                # get host of first running server in cloud
+                if token is not None:
+                    cloud_requestor = CloudRequestor(cloud_endpoint, token)
+                    r = cloud_requestor.request("GET", "get server list", "servers/")
+                    servers = r.json()
+                    if len(servers):
+                        server_id = servers[0]["server_id"]
+                        host = servers[0]["url"]
+                        inform(f"Connecting to server {server_id}.")
+                        _wait_for_server_startup(cloud_endpoint, token, server_id, host)
+                    else:
+                        inform("No cloud server running. Starting new server.")
+
+            if host is None:
+                # start a server (locally or on cloud)
+                from .server import Server
+
+                server = Server(token=token, cloud_endpoint=cloud_endpoint)
+                host = server.host
 
         if token is None:
             token = "selfhosted"
-            
+
         self.requestor = OptimizerRequestor(host=host, token=token, verbose=verbose)
         if check:
             self.check_server()
@@ -91,7 +124,6 @@ class Client:
         if self.requestor.verbose:
             inform(f"Polling server at {self.requestor.endpoint}")
         answer = self.requestor.get("check server")
-        answer = self.requestor.get("check server")
         optimizer_version = str(answer["version"])
         if optimizer_version != __version__:
             warn(
@@ -134,7 +166,7 @@ class Client:
           shutdown_time: The time at which the optimization server should be
             shut down.
         """
-        
+
         self.requestor.post(
             "set server shutdown time",
             "server",
@@ -157,6 +189,8 @@ class Client:
         dashboard: bool = True,
         open_browser: Optional[bool] = None,
         clear_storage: bool = False,
+        extend_on_request: Optional[timedelta] = None,
+        extend_on_suggestion: Optional[timedelta] = None,
         **kwargs: Any,
     ) -> Study:
         """Creates a new :class:`~jcmoptimizer.Study` instance. Example::
@@ -301,6 +335,28 @@ class Client:
             etc.) from previous runs of the study is cleared before creating the
             study.
 
+          extend_on_request: If specified, the shutdown time of a cloud-based
+            server is extended in each request, such that the server will always run
+            for at least the specified amount of time after the request.
+            If not specified, the value is retrieved from the
+            :ref:`Configuration` file. Default: 5 minutes. Example::
+
+              study = client.create_study(
+                 study_id="my-study",
+                 extend_on_request=timedelta(minutes=10)
+              )
+
+          extend_on_suggestion: If specified, the shutdown time of a cloud-based
+            server is extended in each suggestion requested with ``study.get_suggestion()``,
+            such that the server will always run for at least the specified amount of time
+            after the request. If not specified, the value is retrieved from the
+            :ref:`Configuration` file. Default: 30 minutes. Example::
+
+              study = client.create_study(
+                 study_id="my-study",
+                 extend_on_suggestion=timedelta(hours=1, minutes=30)
+              )
+
         """
 
         if "domain" in kwargs:
@@ -315,6 +371,24 @@ class Client:
                 "Please use the 'study_name' argument instead."
             )
 
+        if extend_on_request is None:
+            if "extend_on_request" in self.config:
+                extend_on_request = self.config["extend_on_request"]
+                if not isinstance(extend_on_request, timedelta):
+                    raise TypeError("Invalid format of 'extend_on_request' in config file")
+            else:
+                extend_on_request = timedelta(minutes=5)            
+        if extend_on_suggestion is None:
+            if "extend_on_suggestion" in self.config:
+                extend_on_suggestion = self.config["extend_on_suggestion"]
+                if not isinstance(extend_on_suggestion, timedelta):
+                    raise TypeError(
+                        "Invalid format of 'extend_on_suggestion' in config file"
+                    )
+            else:
+                extend_on_suggestion = timedelta(minutes=30)  
+
+
         answer = self.requestor.post(
             "create study",
             "study",
@@ -343,21 +417,20 @@ class Client:
         )
         if open_browser is None:
             open_browser = self.config.get("open_browser", True)
-            
+
         if answer["dashboard_path"]:
-            dashboard_path = self.requestor.endpoint + answer['dashboard_path']
-            inform(
-                f"The dashboard is accessible via {dashboard_path}"
-            )
+            dashboard_path = self.requestor.endpoint + answer["dashboard_path"]
+            inform(f"The dashboard is accessible via {dashboard_path}")
             if open_browser:
                 webbrowser.open(dashboard_path)
-                
 
         study = Study(
             study_id=answer["study_id"],
             project_id=answer["project_id"],
             driver=driver_instance,
             requestor=self.requestor,
+            extend_on_request=extend_on_request,
+            extend_on_suggestion=extend_on_suggestion,
         )
 
         return study

{jcmoptimizer-3.0.0 → jcmoptimizer-3.0.2}/jcmoptimizer/requestor.py

@@ -3,6 +3,7 @@ import sys
 import threading
 import os
 from datetime import datetime as dt
+from datetime import timedelta
 import json
 import itertools
 import threading
@@ -64,14 +65,14 @@ def work_animation(work_done: threading.Event, msg: str) -> None:
         time.sleep(0.15)
 
 
-def show_working(msg) -> None:
+def show_working(msg: str) -> None:
     WORK_DONE.clear()
     t = threading.Thread(target=work_animation, args=(WORK_DONE, msg))
     t.daemon = True
     t.start()
 
 
-def hide_working():
+def hide_working() -> None:
     wait = not WORK_DONE.is_set()
     WORK_DONE.set()
     if wait:
@@ -100,6 +101,9 @@ def _get_value(expr: str) -> Any:
         return expr.strip('"')
     if expr.isdigit():
         return int(expr)
+    if expr.count(":") == 2:
+        h,m,s = expr.split(":")
+        return timedelta(hours=int(h),minutes=int(m),seconds=int(s))
     try:
         return float(expr)
     except ValueError:
@@ -193,6 +197,7 @@ class Requestor:
                 if method == "GET":
                     response = self.session.get(url)
                 elif method == "POST":
+                    assert data is not None
                     response = self.session.post(
                         url,
                         data=self.encode_data(data),
@@ -220,11 +225,14 @@ class Requestor:
         try:
             response_data = response.json()
         except requests.exceptions.JSONDecodeError as err:
+            excerpt = ""
+            if response._content is not None:
+                excerpt = f"\n{response._content[:1000]!r}"
             raise EnvironmentError(
                 f"Cannot decode answer: {err}"
                 f"\nRequest: {method} {url} {data}"
                 f"\nResponse: {response.status_code} {response.reason}"
-                f"\n{response._content[:1000]!r}"
+                f"{excerpt}"
             ) from err
 
         self.check_status_code(
@@ -236,7 +244,7 @@ class Requestor:
         self,
         purpose: str,
         status_code: int,
-        data: dict[str, Any],
+        data: Optional[dict[str, Any]],
         response_data: dict[str, Any],
     ) -> None:
         if status_code >= 500:
@@ -288,7 +296,7 @@ class OptimizerRequestor(Requestor):
         self,
         purpose: str,
         status_code: int,
-        data: dict[str, Any],
+        data: Optional[dict[str, Any]],
         response_data: dict[str, Any],
     ) -> None:
         if status_code == 202:

{jcmoptimizer-3.0.0 → jcmoptimizer-3.0.2}/jcmoptimizer/server.py

@@ -6,7 +6,7 @@ import json
 import tempfile
 import time
 import subprocess
-from datetime import datetime
+from datetime import datetime, timedelta
 import atexit
 import requests
 
@@ -34,6 +34,51 @@ def _server_response(log_file: Any, error_file: Any, max_lines: int = 10) -> str
 STARTUP_TIMEOUT = 5
 
 
+def _wait_for_server_startup(
+    cloud_endpoint: str, token: str, server_id: str, host: str
+) -> None:
+    cloud_requestor = CloudRequestor(
+        cloud_endpoint=cloud_endpoint,
+        token=token,
+    )
+    prev_state: Optional[str] = None
+    while True:
+        r = cloud_requestor.request(
+            method="GET",
+            purpose="check JCMoptimizer server state",
+            path=f"servers/{server_id}/",
+        )
+        data = r.json()
+        state_dict = json.loads(data["state"])
+        state = state_dict["key"]
+        if state == "running":
+            break
+        if prev_state != state:
+            hide_working()
+            show_working(state_dict["description"])
+            prev_state = state
+        time.sleep(0.5)
+
+    # Try to connect with client
+    t0 = time.time()
+    while time.time() - t0 < STARTUP_TIMEOUT:
+        try:
+            client = Client(
+                host=host,
+                verbose=False,
+                cloud_endpoint=cloud_endpoint,
+                token=token,
+            )
+        except ConnectionError:
+            time.sleep(0.1)
+        else:
+            break
+
+    # Hide only if show_working was called.
+    if prev_state is not None:
+        hide_working()
+
+
 class TimeoutError(Exception):
     pass
 
@@ -57,11 +102,11 @@ class Server:
        study = client.create_study(...)
 
     .. note::
-      If you know the ID of a running cloud-based server, you can 
+      If you know the ID of a running cloud-based server, you can
       directly connect to it via ``client = Client(server_id='leonardo')``.
       Likewise, if you know the port of a local server you can connect via
       ``client = Client(host=http://locahost:4554')``.
-    
+
     General Arguments
     ~~~~~~~~~~~~~~~~~~
     The following arguments are available for all server instances.
@@ -138,7 +183,7 @@ class Server:
 
     def __init__(
         self,
-        server_location: Literal["cloud", "local"] | None = None,
+        server_location: Optional[Literal["cloud", "local"]] = None,
         persistent: bool = False,
         server_id: Optional[str] = None,
         server_name: Optional[str] = None,
@@ -194,22 +239,32 @@ class Server:
                     "Server location 'cloud' requires 'token' to be specified."
                 )
             shutdown_at_str = None
-            if shutdown_at is not None:
-                if not isinstance(shutdown_at, datetime):
-                    raise ValueError(
-                        f"'shutdown_at' must be a {type(datetime)} object. "
-                        f"Got {shutdown_at} of type {type(shutdown_at)}."
-                    )
-                shutdown_at_str = shutdown_at.astimezone().isoformat()
+            if shutdown_at is None:
+                if "server_runtime" in config:
+                    server_runtime = config["server_runtime"]
+                    if not isinstance(server_runtime, timedelta):
+                        raise ValueError(
+                            "Invalid format of 'server_runtime' in config file"
+                        )
+                else:
+                    server_runtime = timedelta(minutes=30)
+                shutdown_at = datetime.now() + server_runtime
+
+            elif not isinstance(shutdown_at, datetime):
+                raise ValueError(
+                    f"'shutdown_at' must be a {type(datetime)} object. "
+                    f"Got {shutdown_at} of type {type(shutdown_at)}."
+                )
+            shutdown_at_str = shutdown_at.astimezone().isoformat()
 
             self._start_cloud_server(
                 persistent=persistent,
                 server_id=server_id,
                 server_name=server_name,
                 shutdown_at=shutdown_at_str,
-                token=token,
-                cloud_endpoint=cloud_endpoint,
                 version=version,
+                cloud_endpoint=cloud_endpoint,
+                token=token,
             )
 
         elif self.server_location == "local":
@@ -254,11 +309,10 @@ class Server:
         server_id: Optional[str],
         server_name: Optional[str],
         shutdown_at: Optional[str],
-        token: str,
         cloud_endpoint: str,
+        token: str,
         version: str,
     ) -> None:
-
         cloud_requestor = CloudRequestor(
             cloud_endpoint=cloud_endpoint,
             token=token,
@@ -275,43 +329,10 @@ class Server:
             ),
         )
         data = response.json()
-        self._optimizer_id = data["optimizer_id"]
         self._host = data["url"]
         self._id = data["server_id"]
 
-        prev_state_key: Optional[str] = None
-        state = json.loads(data["state"])
-        while state["key"] != "running":
-            if prev_state_key != state["key"]:
-                hide_working()
-                show_working(state["description"])
-                prev_state_key = state["key"]
-            time.sleep(0.5)
-            r = cloud_requestor.request(
-                method="GET",
-                purpose="check JCMoptimizer server state",
-                path=f"servers/{self._id}/",
-            )
-            data = r.json()
-            state = json.loads(data["state"])
-
-        # Try to connect with client
-        t0 = time.time()
-        while time.time() - t0 < STARTUP_TIMEOUT:
-            try:
-                client = Client(
-                    host=self._host,
-                    verbose=False,
-                    cloud_endpoint=cloud_endpoint,
-                    token=token,
-                )
-            except ConnectionError:
-                time.sleep(0.1)
-            else:
-                break
-
-        hide_working()
-
+        _wait_for_server_startup(cloud_endpoint, token, self._id, self._host)
         inform(f"JCMoptimizer {self._id!r} started. Host: {self._host}")
 
         if not persistent:

{jcmoptimizer-3.0.0 → jcmoptimizer-3.0.2}/jcmoptimizer/study.py

@@ -5,6 +5,7 @@ import warnings
 import traceback
 import atexit
 import requests
+from datetime import datetime, timedelta
 
 from .requestor import OptimizerRequestor, NumParallelError, warn
 from .objects import Observation, Suggestion
@@ -12,7 +13,6 @@ from .drivers import Driver
 
 
 class Study:
-
     """
     This class provides methods for controlling a numerical optimization study.
     Example::
@@ -48,11 +48,15 @@ class Study:
         project_id: str,
         driver: Driver,
         requestor: OptimizerRequestor,
+        extend_on_request: Optional[timedelta] = None,
+        extend_on_suggestion: Optional[timedelta] = None,
     ) -> None:
         self.study_id = study_id
         self.project_id = project_id
         self._driver = driver
         self._requestor = requestor
+        self._extend_on_request = extend_on_request
+        self._extend_on_suggestion = extend_on_suggestion
         self.evaluator: Optional[Callable[..., Observation]] = None
         self.num_failed = 0
         self.max_num_failed = 3
@@ -80,12 +84,35 @@ class Study:
         operation: str,
         data: Optional[dict[str, Any]] = None,
     ) -> dict[str, Any]:
-        return self._requestor.post(
-            purpose, object, operation, self.qualifier, data
-        )
+        result = self._requestor.post(purpose, object, operation, self.qualifier, data)
+        self._extend_shutdown_time(self._extend_on_request)
+        if purpose == "get suggestion":
+            self._extend_shutdown_time(self._extend_on_suggestion)
+        return result
 
     def _get(self, purpose: str, object: str, type: str) -> dict[str, Any]:
-        return self._requestor.get(purpose, object, type, self.qualifier)
+        result = self._requestor.get(purpose, object, type, self.qualifier)
+        self._extend_shutdown_time(self._extend_on_request)
+        return result
+
+    def _extend_shutdown_time(self, duration: Optional[timedelta]) -> None:
+        if duration is None:
+            return
+        r = self._requestor.get("check server")
+        if "shutdown_at" not in r:
+            # not a cloud-based server
+            return
+
+        shutdown_at = datetime.fromisoformat(r["shutdown_at"])
+        now = datetime.now().astimezone()
+        if shutdown_at < now + duration:
+            new_shutdown_at = now + duration
+            self._requestor.post(
+                "extend server shutdown time",
+                "server",
+                "update_shutdown_at",
+                data={"shutdown_at": new_shutdown_at.astimezone().isoformat()},
+            )
 
     def _delete_on_server(self) -> None:
         if self.deleted:

jcmoptimizer-3.0.2/jcmoptimizer/version.py

@@ -0,0 +1 @@
+__version__ = '3.0.2'

{jcmoptimizer-3.0.0 → jcmoptimizer-3.0.2}/jcmoptimizer.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jcmoptimizer
-Version: 3.0.0
+Version: 3.0.2
 Summary: The JCMoptimizer interface for Python
 Author-email: Philipp Schneider <philipp.schneider@jcmwave.com>
 License-Expression: MIT
@@ -20,16 +20,23 @@ Dynamic: license-file
 
 This package implements a python client for interacting with the JCMoptimizer server. It provides a convenient interface to set up, run, and analyze numerical studies of expensive black box functions.
 
-## Getting Started ##
+## Getting Started
 
-You need install JCMsuite and the JCMoptimizer extension for JCMsuite:
-* Browse to the [JCMsuite download](https://installation.jcmwave.com/fb13885794fc64c42531c9656f8f6f73.php) page to install JCMsuite and to retrieve a demo or commercial license.
-* Browse to the [JCMoptimizer download](https://optimizer.jcmwave.com/download-jcmoptimizer) page to install JCMoptimzizer.
+### Cloud Service
+The easiest way to get started is to use the free tier of the JCMwave's cloud service for JCMoptimizer:
 * Install the `jcmoptimizer` package into your python environmentm, e.g. by runing `pip install jcmoptimizer`.
+* Signup to [optimizer.jcmwave.com](https://optimizer.jcmwave.com).
+* Create an [API access token](https://optimizer.jcmwave.com/cloud/tokens/list/)
+
+### Run JCMoptimizer Locally
+For a self-hosted version, you need install JCMsuite and the JCMoptimizer extension for JCMsuite:
+* Browse to the [JCMsuite download](https://installation.jcmwave.com/fb13885794fc64c42531c9656f8f6f73.php) page to install JCMsuite and to retrieve a demo or commercial license.
+* Browse to the [JCMoptimizer download](https://optimizer.jcmwave.com/download) page to install JCMoptimzizer.
 
+### First Example
 A basic usage example of the python package is given in the tutorial on a [Bayesian Optimization](https://optimizer.jcmwave.com/documentation/python/latest/tutorials/vanilla_bayesian_optimization.html).
 
-## Documentation ##
+## Documentation
 
 For a comprehensive overview of all available classes, methods, and their parameters, please refer to the official JCMoptimizer Python documentation:
 

jcmoptimizer-3.0.0/jcmoptimizer/version.py

@@ -1 +0,0 @@
-__version__ = '3.0.0'