invrs-opt 0.6.0__py3-none-any.whl → 0.7.1__py3-none-any.whl

invrs_opt/wrapped_optax/wrapped_optax.py

@@ -1,150 +0,0 @@
-import dataclasses
-from typing import Any, Callable, Tuple
-
-import jax
-import jax.numpy as jnp
-import optax  # type: ignore[import-untyped]
-from jax import tree_util
-from totypes import types
-
-from invrs_opt import base, transform
-
-PyTree = Any
-WrappedOptaxState = Tuple[PyTree, PyTree, PyTree]
-
-
-def wrapped_optax(opt: optax.GradientTransformation) -> base.Optimizer:
-    """Return a wrapped optax optimizer."""
-    return transformed_wrapped_optax(
-        opt=opt,
-        transform_fn=lambda x: x,
-        initialize_latent_fn=lambda x: x,
-    )
-
-
-def density_wrapped_optax(
-    opt: optax.GradientTransformation,
-    beta: float,
-) -> base.Optimizer:
-    """Return a wrapped optax optimizer with transforms for density arrays."""
-
-    def transform_fn(tree: PyTree) -> PyTree:
-        return tree_util.tree_map(
-            lambda x: transform_density(x) if _is_density(x) else x,
-            tree,
-            is_leaf=_is_density,
-        )
-
-    def initialize_latent_fn(tree: PyTree) -> PyTree:
-        return tree_util.tree_map(
-            lambda x: initialize_latent_density(x) if _is_density(x) else x,
-            tree,
-            is_leaf=_is_density,
-        )
-
-    def transform_density(density: types.Density2DArray) -> types.Density2DArray:
-        transformed = types.symmetrize_density(density)
-        transformed = transform.density_gaussian_filter_and_tanh(transformed, beta=beta)
-        # Scale to ensure that the full valid range of the density array is reachable.
-        mid_value = (density.lower_bound + density.upper_bound) / 2
-        transformed = tree_util.tree_map(
-            lambda array: mid_value + (array - mid_value) / jnp.tanh(beta), transformed
-        )
-        return transform.apply_fixed_pixels(transformed)
-
-    def initialize_latent_density(
-        density: types.Density2DArray,
-    ) -> types.Density2DArray:
-        array = transform.normalized_array_from_density(density)
-        array = jnp.clip(array, -1, 1)
-        array *= jnp.tanh(beta)
-        latent_array = jnp.arctanh(array) / beta
-        latent_array = transform.rescale_array_for_density(latent_array, density)
-        return dataclasses.replace(density, array=latent_array)
-
-    return transformed_wrapped_optax(
-        opt=opt,
-        transform_fn=transform_fn,
-        initialize_latent_fn=initialize_latent_fn,
-    )
-
-
-def transformed_wrapped_optax(
-    opt: optax.GradientTransformation,
-    transform_fn: Callable[[PyTree], PyTree],
-    initialize_latent_fn: Callable[[PyTree], PyTree],
-) -> base.Optimizer:
-    """Return a wrapped optax optimizer for transformed latent parameters.
-
-    Args:
-        opt: The optax `GradientTransformation` to be wrapped.
-        transform_fn: Function which transforms the internal latent parameters to
-            the parameters returned by the optimizer.
-        initialize_latent_fn: Function which computes the initial latent parameters
-            given the initial parameters.
-
-    Returns:
-        The `base.Optimizer`.
-    """
-
-    def init_fn(params: PyTree) -> WrappedOptaxState:
-        """Initializes the optimization state."""
-        latent_params = initialize_latent_fn(_clip(params))
-        params = transform_fn(latent_params)
-        return params, latent_params, opt.init(latent_params)
-
-    def params_fn(state: WrappedOptaxState) -> PyTree:
-        """Returns the parameters for the given `state`."""
-        params, _, _ = state
-        return params
-
-    def update_fn(
-        *,
-        grad: PyTree,
-        value: float,
-        params: PyTree,
-        state: WrappedOptaxState,
-    ) -> WrappedOptaxState:
-        """Updates the state."""
-        del value
-
-        _, latent_params, opt_state = state
-        _, vjp_fn = jax.vjp(transform_fn, latent_params)
-        (latent_grad,) = vjp_fn(grad)
-
-        updates, opt_state = opt.update(latent_grad, opt_state)
-        latent_params = optax.apply_updates(params=latent_params, updates=updates)
-        latent_params = _clip(latent_params)
-        params = transform_fn(latent_params)
-        return params, latent_params, opt_state
-
-    return base.Optimizer(
-        init=init_fn,
-        params=params_fn,
-        update=update_fn,
-    )
-
-
-def _is_density(leaf: Any) -> Any:
-    """Return `True` if `leaf` is a density array."""
-    return isinstance(leaf, types.Density2DArray)
-
-
-def _is_custom_type(leaf: Any) -> bool:
-    """Return `True` if `leaf` is a recognized custom type."""
-    return isinstance(leaf, (types.BoundedArray, types.Density2DArray))
-
-
-def _clip(pytree: PyTree) -> PyTree:
-    """Clips leaves on `pytree` to their bounds."""
-
-    def _clip_fn(leaf: Any) -> Any:
-        if not _is_custom_type(leaf):
-            return leaf
-        if leaf.lower_bound is None and leaf.upper_bound is None:
-            return leaf
-        return tree_util.tree_map(
-            lambda x: jnp.clip(x, leaf.lower_bound, leaf.upper_bound), leaf
-        )
-
-    return tree_util.tree_map(_clip_fn, pytree, is_leaf=_is_custom_type)

invrs_opt-0.6.0.dist-info/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2023 The INVRS-IO authors.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

invrs_opt-0.6.0.dist-info/METADATA

@@ -1,76 +0,0 @@
-Metadata-Version: 2.1
-Name: invrs_opt
-Version: 0.6.0
-Summary: Algorithms for inverse design
-Author-email: "Martin F. Schubert" <mfschubert@gmail.com>
-Maintainer-email: "Martin F. Schubert" <mfschubert@gmail.com>
-License: MIT License
-        
-        Copyright (c) 2023 The INVRS-IO authors.
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-        
-Keywords: topology,optimization,jax,inverse design
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: jax
-Requires-Dist: jaxlib
-Requires-Dist: numpy
-Requires-Dist: requests
-Requires-Dist: optax
-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'
-Requires-Dist: mypy ; extra == 'dev'
-Requires-Dist: pre-commit ; extra == 'dev'
-Provides-Extra: tests
-Requires-Dist: parameterized ; extra == 'tests'
-Requires-Dist: pytest ; extra == 'tests'
-Requires-Dist: pytest-cov ; extra == 'tests'
-Requires-Dist: pytest-subtests ; extra == 'tests'
-
-# invrs-opt - Optimization algorithms for inverse design
-`v0.6.0`
-
-## Overview
-
-The `invrs-opt` package defines an optimizer API intended for topology optimization, inverse design, or AI-guided design. It (currently) implements the L-BFGS-B optimization algorithm along with some variants. The API is intended to be general so that new algorithms can be accommodated, and is inspired by the functional optimizer approach used in jax. Example usage is as follows:
-
-```python
-initial_params = ...
-
-optimizer = invrs_opt.lbfgsb()
-state = optimizer.init(initial_params)
-
-for _ in range(steps):
-    params = optimizer.params(state)
-    value, grad = jax.value_and_grad(loss_fn)(params)
-    state = optimizer.update(grad=grad, value=value, params=params, state=state)
-```
-
-Optimizers in `invrs-opt` are compatible with custom types defined in the [totypes](https://github.com/invrs-io/totypes) package. The basic `lbfgsb` optimizer enforces bounds for custom types, while the `density_lbfgsb` optimizer implements a filter-and-threshold operation for `DensityArray2D` types to ensure that solutions have the correct length scale.
-
-## Install
-```
-pip install invrs_opt
-```

invrs_opt-0.6.0.dist-info/RECORD

@@ -1,16 +0,0 @@
-invrs_opt/__init__.py,sha256=35pvMpeqvJgU4DizUO5hTzeE9j93prbB9RMtcaoFYwg,496
-invrs_opt/base.py,sha256=FdQyPTlWGo03YztI3K2_QBN6Q-v0PeXv6XCyXu_uh_4,1160
-invrs_opt/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-invrs_opt/transform.py,sha256=a_Saj9Wq4lvqCJBrg5L2Z9DZ2NVs1xqrHLqha90a9Ws,5971
-invrs_opt/experimental/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-invrs_opt/experimental/client.py,sha256=MqC_TguT9IGrG7WW54vwz6QQMylKkbCjHxFPIG9vQMA,4841
-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=pfrqCaOMco-eHUQe2q03hbla9D2TYqmMB-07jK4-5Ik,27792
-invrs_opt/wrapped_optax/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-invrs_opt/wrapped_optax/wrapped_optax.py,sha256=-ke0MNCb2EB0ntlj5IHIHrvybOVF4m24DM6JI4_Ktcc,4974
-invrs_opt-0.6.0.dist-info/LICENSE,sha256=ty6jHPvpyjHy6dbhnu6aDSY05bbl2jQTjnq9u1sBCfM,1078
-invrs_opt-0.6.0.dist-info/METADATA,sha256=V4hpzjEovC2CU0IgUBMAgKzPfgqGvLlutQ9X5-FOuIk,3347
-invrs_opt-0.6.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-invrs_opt-0.6.0.dist-info/top_level.txt,sha256=hOziS2uJ_NgwaW9yhtOfeuYnm1X7vobPBcp_6eVWKfM,10
-invrs_opt-0.6.0.dist-info/RECORD,,