jcmoptimizer 3.0.2__tar.gz → 3.0.4__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jcmoptimizer
-Version: 3.0.2
+Version: 3.0.4
 Summary: The JCMoptimizer interface for Python
 Author-email: Philipp Schneider <philipp.schneider@jcmwave.com>
 License-Expression: MIT
@@ -24,14 +24,14 @@ This package implements a python client for interacting with the JCMoptimizer se
 
 ### 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`.
+* Install the `jcmoptimizer` package into your python environment, e.g. by running `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.
+* Browse to the [JCMoptimizer download](https://optimizer.jcmwave.com/download) page to install JCMoptimizer.
 
 ### 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).

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

@@ -6,14 +6,14 @@ This package implements a python client for interacting with the JCMoptimizer se
 
 ### 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`.
+* Install the `jcmoptimizer` package into your python environment, e.g. by running `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.
+* Browse to the [JCMoptimizer download](https://optimizer.jcmwave.com/download) page to install JCMoptimizer.
 
 ### 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).

{jcmoptimizer-3.0.2 → jcmoptimizer-3.0.4}/jcmoptimizer/drivers/driver.py

@@ -4,6 +4,7 @@ import time
 
 from ..requestor import OptimizerRequestor
 
+
 class Driver:
     """This class provides methods for retrieving and setting driver-specific
     information of the study. Depending on the chosen driver of
@@ -19,8 +20,10 @@ class Driver:
     The constructor should not be used directly since it does not create a
     driver on the server side. Instead, one should use :attr:`Study.driver`.
     """
-    
-    def __init__(self, study_id: str, project_id: str, requestor: OptimizerRequestor) -> None:
+
+    def __init__(
+        self, study_id: str, project_id: str, requestor: OptimizerRequestor
+    ) -> None:
         self._requestor = requestor
         self.study_id = study_id
         self.project_id = project_id
@@ -28,7 +31,7 @@ class Driver:
     @property
     def qualifier(self) -> str:
         return self.project_id + "." + self.study_id
-    
+
     def _post(
         self,
         purpose: str,
@@ -38,7 +41,7 @@ class Driver:
     ) -> dict[str, Any]:
         return self._requestor.post(purpose, object, operation, self.qualifier, data)
 
-    def _get(self, purpose:str, object: str, type: str) -> dict[str, Any]:
+    def _get(self, purpose: str, object: str, type: str) -> dict[str, Any]:
         return self._requestor.get(purpose, object, type, self.qualifier)
 
     def _run_task(self, purpose: str, task: str, data: dict[str, Any]) -> Any:
@@ -82,11 +85,11 @@ class Driver:
         Returns: A nested dictionary with description of submodules consisting
                of a name and a descriptive text. If the entry describes a module,
                it has an additional ``"members"`` entry with dictionaries describing
-               submodules and parameters. 
+               submodules and parameters.
         """
         answer = self._get("get description of the driver", "driver", "describe")
         return answer["description"]
-    
+
     def get_state(self, path: Optional[str] = None) -> dict[str, Any]:
         """Get state of the driver. Example::
 
@@ -105,7 +108,7 @@ class Driver:
             "get driver state", "driver", "get_state", data={"path": path}
         )
         return answer["state"]
-    
+
     def historic_parameter_values(self, path: str) -> list[Any]:
         """Get the values of an internal parameter for each iteration of the study. Example::
 
@@ -125,10 +128,11 @@ class Driver:
             data={"path": path},
         )
         return answer["values"]
-    
+
+
 class Minimizer(Driver):
     """
-    This class provides methods for retieving and setting information of the
+    This class provides methods for retrieving and setting information of the
     minimization driver of the study.
     """
 
@@ -139,7 +143,7 @@ class Minimizer(Driver):
 
           for key, value in driver.best_sample.items():
              print(f"{key} = {value}")
-        
+
         """
         answer = self._post(
             "get best sample", "driver", "get_state", data={"path": "best_sample"}
@@ -155,13 +159,17 @@ class Minimizer(Driver):
 
         """
         answer = self._post(
-            "get minimal objective value", "driver", "get_state", data={"path": "min_objective"}
+            "get minimal objective value",
+            "driver",
+            "get_state",
+            data={"path": "min_objective"},
         )
         return answer["state"]
 
+
 class LeastSquaresDriver(Minimizer):
     """
-    This class provides methods for retieving information of the
+    This class provides methods for retrieving information of the
     result of the least squares minimization using ``scipy.optimize.least_squares``.
     """
 

{jcmoptimizer-3.0.2 → jcmoptimizer-3.0.4}/jcmoptimizer/drivers/third_party_drivers.py

@@ -3,7 +3,7 @@ from .driver import Minimizer, LeastSquaresDriver
 
 class DifferentialEvolution(Minimizer):
     """
-    This class provides methods for retieving information of the
+    This class provides methods for retrieving information of the
     result of the differential evolution.
     """
 
@@ -12,7 +12,7 @@ class DifferentialEvolution(Minimizer):
 
 class CMAES(Minimizer):
     """
-    This class provides methods for retieving information of the
+    This class provides methods for retrieving information of the
     result of the CMA-ES minimization.
     """
 
@@ -21,7 +21,7 @@ class CMAES(Minimizer):
 
 class ScipyMinimizer(Minimizer):
     """
-    This class provides methods for retieving information of the
+    This class provides methods for retrieving information of the
     result of the minimization using ``scipy.optimize.minimize``.
     """
 
@@ -30,7 +30,7 @@ class ScipyMinimizer(Minimizer):
 
 class ScipyLeastSquares(LeastSquaresDriver):
     """
-    This class provides methods for retieving information of the
+    This class provides methods for retrieving information of the
     result of the least squares minimization using ``scipy.optimize.least_squares``.
     """
 

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

@@ -53,6 +53,7 @@ def warn(message: str) -> None:
 WORK_DONE = threading.Event()
 WORK_DONE.set()
 
+
 def work_animation(work_done: threading.Event, msg: str) -> None:
     for c in itertools.cycle("⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏"):
         if work_done.is_set():
@@ -87,9 +88,11 @@ class ServerError(EnvironmentError):
 class NumParallelError(EnvironmentError):
     pass
 
+
 class ServerShutdownError(EnvironmentError):
     pass
 
+
 def _get_value(expr: str) -> Any:
     if expr == "true":
         return True
@@ -102,12 +105,13 @@ def _get_value(expr: str) -> Any:
     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))
+        h, m, s = expr.split(":")
+        return timedelta(hours=int(h), minutes=int(m), seconds=int(s))
     try:
         return float(expr)
     except ValueError:
-        raise SyntaxError
+        # default to string
+        return expr
 
 
 def parse_yaml(f: TextIO) -> dict[str, Any]:
@@ -158,7 +162,6 @@ def read_yml_config_files() -> dict[str, Any]:
 
 
 class Requestor:
-
     def __init__(self, endpoint: str, token: str) -> None:
         is_in_notebook = False
         try:
@@ -249,7 +252,7 @@ class Requestor:
     ) -> None:
         if status_code >= 500:
             raise ServerError(
-                "An internal server error occured. Please, check your entries."
+                "An internal server error occurred. Please, check your entries."
                 f"\nRequest: {data}"
                 f"\nResponse: {status_code} {response_data}"
             )
@@ -264,7 +267,6 @@ class Requestor:
 
 
 class CloudRequestor(Requestor):
-
     def __init__(self, cloud_endpoint: str, token: str) -> None:
         super().__init__(endpoint=cloud_endpoint, token=token)
 
@@ -278,7 +280,6 @@ class CloudRequestor(Requestor):
 
 
 class OptimizerRequestor(Requestor):
-
     def __init__(
         self,
         host: str,
@@ -328,8 +329,7 @@ class OptimizerRequestor(Requestor):
             raise ServerShutdownError(
                 f"Could not {purpose}. The server is shutting down."
             )
-            
-            
+
     def get(
         self,
         purpose: str,

jcmoptimizer-3.0.4/jcmoptimizer/version.py

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jcmoptimizer
-Version: 3.0.2
+Version: 3.0.4
 Summary: The JCMoptimizer interface for Python
 Author-email: Philipp Schneider <philipp.schneider@jcmwave.com>
 License-Expression: MIT
@@ -24,14 +24,14 @@ This package implements a python client for interacting with the JCMoptimizer se
 
 ### 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`.
+* Install the `jcmoptimizer` package into your python environment, e.g. by running `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.
+* Browse to the [JCMoptimizer download](https://optimizer.jcmwave.com/download) page to install JCMoptimizer.
 
 ### 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).

jcmoptimizer-3.0.2/jcmoptimizer/version.py

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