invrs-opt 0.3.2__py3-none-any.whl → 0.4.0__py3-none-any.whl

invrs_opt/__init__.py

@@ -3,7 +3,7 @@
 Copyright (c) 2023 The INVRS-IO authors.
 """
 
-__version__ = "v0.3.2"
+__version__ = "v0.4.0"
 __author__ = "Martin F. Schubert <mfschubert@gmail.com>"
 
 from invrs_opt.lbfgsb.lbfgsb import density_lbfgsb as density_lbfgsb

invrs_opt/experimental/client.py

@@ -0,0 +1,152 @@
+"""Defines basic client optimizers for use with an optimization service.
+
+Copyright (c) 2023 The INVRS-IO authors.
+"""
+
+import json
+import requests
+import time
+from typing import Any, Dict, Optional
+
+from totypes import json_utils
+
+from invrs_opt import base
+from invrs_opt.experimental import labels
+
+
+PyTree = Any
+StateToken = str
+
+SESSION = None
+SERVER_ADDRESS = None
+
+
+def login(server_address: str) -> None:
+    """Set the global server address and create a requests session."""
+    global SESSION
+    global SERVER_ADDRESS
+    SESSION = requests.Session()
+    SERVER_ADDRESS = server_address
+
+
+def optimizer_client(
+    algorithm: str,
+    hparams: Dict[str, Any],
+    server_address: Optional[str],
+    session: Optional[requests.Session],
+) -> base.Optimizer:
+    """Generic optimizer class."""
+
+    if server_address is None:
+        if SERVER_ADDRESS is None:
+            raise ValueError(
+                "Argument `server_address` and the global `SERVER_ADDRESS` cannot "
+                "both be `None`. Use the `login` method to set the global, or "
+                "explicitly provide a value."
+            )
+    if session is None:
+        if SESSION is None:
+            raise ValueError(
+                "Argument `session` and the global `SESSION` cannot "
+                "both be `None`. Use the `login` method to set the global, or "
+                "explicitly provide a value."
+            )
+        session = SESSION
+
+    opt_config = {
+        labels.ALGORITHM: algorithm,
+        labels.HPARAMS: hparams,
+    }
+
+    def init_fn(params: PyTree) -> StateToken:
+        """Handles 'init' requests."""
+        serialized_data = json_utils.json_from_pytree(
+            dict(opt_config=opt_config, data={"params": params})
+        )
+        post_response = session.post(
+            f"{SERVER_ADDRESS}/{labels.ROUTE_INIT}/", data=serialized_data
+        )
+
+        if not post_response.status_code == 200:
+            raise requests.RequestException(post_response.text)
+        response = json.loads(post_response.text)
+        new_state_token: str = response[labels.STATE_TOKEN]
+        return new_state_token
+
+    def update_fn(
+        *,
+        grad: PyTree,
+        value: float,
+        params: PyTree,
+        state: StateToken,
+    ) -> StateToken:
+        """Handles 'update' requests."""
+        state_token = state
+        del state
+        serialized_data = json_utils.json_from_pytree(
+            {
+                labels.OPT_CONFIG: opt_config,
+                labels.DATA: {
+                    labels.PARAMS: params,
+                    labels.VALUE: value,
+                    labels.GRAD: grad,
+                    labels.STATE_TOKEN: state_token,
+                },
+            }
+        )
+        post_response = session.post(
+            f"{SERVER_ADDRESS}/{labels.ROUTE_UPDATE}/{state_token}/",
+            data=serialized_data,
+        )
+
+        if not post_response.status_code == 200:
+            raise requests.RequestException(post_response.text)
+        response = json.loads(post_response.text)
+        new_state_token: str = response[labels.STATE_TOKEN]
+        return new_state_token
+
+    def params_fn(
+        state: StateToken,
+        timeout: float = 60.0,
+        poll_interval: float = 0.1,
+    ) -> PyTree:
+        """Handles 'params' requests."""
+        state_token = state
+        del state
+        assert timeout >= poll_interval
+        start_time = time.time()
+        while time.time() < start_time + timeout:
+            get_response = session.get(
+                f"{SERVER_ADDRESS}/{labels.ROUTE_PARAMS}/{state_token}"
+            )
+            if get_response.status_code == 200:
+                break
+            elif get_response.status_code == 404 and get_response.text.endswith(
+                labels.MESSAGE_STATE_NOT_READY.format(state_token)
+            ):
+                time.sleep(poll_interval)
+            else:
+                raise requests.RequestException(get_response.text)
+
+        if not get_response.status_code == 200:
+            raise requests.Timeout("Timed out while waiting for params.")
+        response = json.loads(get_response.text)
+        return json_utils.pytree_from_json(response[labels.PARAMS])
+
+    return base.Optimizer(init=init_fn, update=update_fn, params=params_fn)
+
+
+# -----------------------------------------------------------------------------
+# Specific optimizers implemented here.
+# -----------------------------------------------------------------------------
+
+
+def lbfgsb(maxcor: int = 20, line_search_max_steps: int = 100) -> base.Optimizer:
+    """Optimizer implementing the L-BFGS-B scheme."""
+    hparams = {
+        "maxcor": maxcor,
+        "line_search_max_steps": line_search_max_steps,
+    }
+    return optimizer_client(
+        algorithm="lbfgsb", hparams=hparams, server_address=None, session=None
+    )

invrs_opt/experimental/labels.py

@@ -0,0 +1,23 @@
+"""Defines labels and messages used in the context of an optimization service.
+
+Copyright (c) 2023 The INVRS-IO authors.
+"""
+
+VALUE = "value"
+GRAD = "grad"
+PARAMS = "params"
+STATE_TOKEN = "state_token"
+MESSAGE = "message"
+
+OPT_CONFIG = "opt_config"
+ALGORITHM = "algorithm"
+HPARAMS = "hparams"
+DATA = "data"
+
+ROUTE_INIT = "init"
+ROUTE_UPDATE = "update"
+ROUTE_PARAMS = "params"
+
+MESSAGE_STATE_NOT_KNOWN = "State token {} was not recognized."
+MESSAGE_STATE_NOT_READY = "State for token {} is not ready."
+MESSAGE_STATE_NOT_VALID = "State for token {} is not valid."

invrs_opt/lbfgsb/lbfgsb.py

@@ -261,10 +261,12 @@ def transformed_lbfgsb(
             flat_latent_params = jnp.asarray(scipy_lbfgsb_state.x)
             return flat_latent_params, scipy_lbfgsb_state.to_jax()
 
-        params, latent_params, jax_lbfgsb_state = state
+        _, latent_params, jax_lbfgsb_state = state
         _, vjp_fn = jax.vjp(transform_fn, latent_params)
         (latent_grad,) = vjp_fn(grad)
-        flat_latent_grad, unflatten_fn = flatten_util.ravel_pytree(latent_grad)
+        flat_latent_grad, unflatten_fn = flatten_util.ravel_pytree(
+            latent_grad
+        )  # type: ignore[no-untyped-call]
 
         (
             flat_latent_params,

{invrs_opt-0.3.2.dist-info → invrs_opt-0.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: invrs_opt
-Version: 0.3.2
+Version: 0.4.0
 Summary: Algorithms for inverse design
 Author-email: "Martin F. Schubert" <mfschubert@gmail.com>
 Maintainer-email: "Martin F. Schubert" <mfschubert@gmail.com>
@@ -33,8 +33,10 @@ License-File: LICENSE
 Requires-Dist: jax
 Requires-Dist: jaxlib
 Requires-Dist: numpy
+Requires-Dist: requests
 Requires-Dist: scipy
 Requires-Dist: totypes
+Requires-Dist: types-requests
 Provides-Extra: dev
 Requires-Dist: bump-my-version ; extra == 'dev'
 Requires-Dist: darglint ; extra == 'dev'
@@ -47,7 +49,7 @@ Requires-Dist: pytest-cov ; extra == 'tests'
 Requires-Dist: pytest-subtests ; extra == 'tests'
 
 # invrs-opt - Optimization algorithms for inverse design
-`v0.3.2`
+`v0.4.0`
 
 ## Overview
 

invrs_opt-0.4.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+invrs_opt/__init__.py,sha256=sKLkaXTzj4zJf3pOcXI1uiHRM15tEEr2BhSL4RWQEns,309
+invrs_opt/base.py,sha256=dSX9QkMPzI8ROxy2cFNmMwk_89eQbk0rw94CzvLPQoY,907
+invrs_opt/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+invrs_opt/experimental/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+invrs_opt/experimental/client.py,sha256=td5o_YqqbcSypDrWCVrHGSoF8UxEdOLtKU0z9Dth9lA,4842
+invrs_opt/experimental/labels.py,sha256=dQDAMPyFMV6mXnMy295z8Ap205DRdVzysXny_Be8FmY,562
+invrs_opt/lbfgsb/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+invrs_opt/lbfgsb/lbfgsb.py,sha256=YEBM7XcKj65QpEwO5Y8Mgmjud-h8k-1lF6UsEFgu6sM,25130
+invrs_opt/lbfgsb/transform.py,sha256=a_Saj9Wq4lvqCJBrg5L2Z9DZ2NVs1xqrHLqha90a9Ws,5971
+invrs_opt-0.4.0.dist-info/LICENSE,sha256=ty6jHPvpyjHy6dbhnu6aDSY05bbl2jQTjnq9u1sBCfM,1078
+invrs_opt-0.4.0.dist-info/METADATA,sha256=abuCz0t6ZBbkxwL23I-Ef1m5IKMVJveOjvEl25SmfEw,3326
+invrs_opt-0.4.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+invrs_opt-0.4.0.dist-info/top_level.txt,sha256=hOziS2uJ_NgwaW9yhtOfeuYnm1X7vobPBcp_6eVWKfM,10
+invrs_opt-0.4.0.dist-info/RECORD,,

invrs_opt-0.3.2.dist-info/RECORD

@@ -1,11 +0,0 @@
-invrs_opt/__init__.py,sha256=JG9h93Vq0AA2jX6zcqwxjA-LXOws8CJQeEbY9VQvQWQ,309
-invrs_opt/base.py,sha256=dSX9QkMPzI8ROxy2cFNmMwk_89eQbk0rw94CzvLPQoY,907
-invrs_opt/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-invrs_opt/lbfgsb/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-invrs_opt/lbfgsb/lbfgsb.py,sha256=2X0GVQwMCj2beYHLiAdwoAnBIdJLPThH0Jjduz3GzHA,25080
-invrs_opt/lbfgsb/transform.py,sha256=a_Saj9Wq4lvqCJBrg5L2Z9DZ2NVs1xqrHLqha90a9Ws,5971
-invrs_opt-0.3.2.dist-info/LICENSE,sha256=ty6jHPvpyjHy6dbhnu6aDSY05bbl2jQTjnq9u1sBCfM,1078
-invrs_opt-0.3.2.dist-info/METADATA,sha256=pwrRENMlb_s1bNAeROw-cJ-nIVuqR9815r-jPNM3cEg,3272
-invrs_opt-0.3.2.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-invrs_opt-0.3.2.dist-info/top_level.txt,sha256=hOziS2uJ_NgwaW9yhtOfeuYnm1X7vobPBcp_6eVWKfM,10
-invrs_opt-0.3.2.dist-info/RECORD,,