gpjax 0.9.3__py3-none-any.whl → 0.9.5__py3-none-any.whl

gpjax/decision_making/utility_functions/thompson_sampling.py

@@ -1,101 +0,0 @@
-# Copyright 2023 The JaxGaussianProcesses Contributors. All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-# ==============================================================================
-from dataclasses import dataclass
-
-from beartype.typing import Mapping
-
-from gpjax.dataset import Dataset
-from gpjax.decision_making.utility_functions.base import (
-    AbstractSinglePointUtilityFunctionBuilder,
-    SinglePointUtilityFunction,
-)
-from gpjax.decision_making.utils import OBJECTIVE
-from gpjax.gps import ConjugatePosterior
-from gpjax.typing import KeyArray
-
-
-@dataclass
-class ThompsonSampling(AbstractSinglePointUtilityFunctionBuilder):
-    """
-    Form a utility function by drawing an approximate sample from the posterior,
-    using decoupled sampling as introduced in [Wilson et. al.
-    (2020)](https://arxiv.org/abs/2002.09309). Note that we return the *negative* of the
-    sample as the utility function, as utility functions are *maximised*.
-
-    Note that this is a single batch utility function, as it doesn't support classical
-    batching. However, Thompson sampling can be used in a batched setting by drawing a
-    batch of different samples from the GP posterior. This can be done by calling
-    `build_utility_function` with different keys, an example of which can be seen in the
-    `ask` method of the `UtilityDrivenDecisionMaker` class. The samples can then be
-    optimised sequentially.
-
-    Attributes:
-        num_features (int): The number of random Fourier features to use when drawing
-            the approximate sample from the posterior. Defaults to 100.
-    """
-
-    num_features: int = 100
-
-    def __post_init__(self):
-        if self.num_features <= 0:
-            raise ValueError(
-                "The number of random Fourier features must be a positive integer."
-            )
-
-    def build_utility_function(
-        self,
-        posteriors: Mapping[str, ConjugatePosterior],
-        datasets: Mapping[str, Dataset],
-        key: KeyArray,
-    ) -> SinglePointUtilityFunction:
-        """
-        Draw an approximate sample from the posterior of the objective model and return
-        the *negative* of this sample as a utility function, as utility functions
-        are *maximised*.
-
-        Args:
-            posteriors (Mapping[str, ConjugatePosterior]): Dictionary of posteriors to
-            be used to form the utility function. One of the posteriors must correspond
-            to the `OBJECTIVE` key, as we sample from the objective posterior to form
-            the utility function.
-            datasets (Mapping[str, Dataset]): Dictionary of datasets which may be used
-            to form the utility function. Keys in `datasets` should correspond to
-            keys in `posteriors`. One of the datasets must correspond
-            to the `OBJECTIVE` key.
-            key (KeyArray): JAX PRNG key used for random number generation. This can be
-            changed to draw different samples.
-
-        Returns:
-            SinglePointUtilityFunction: An appproximate sample from the objective model
-                posterior to to be *maximised* in order to decide which point to query
-                next.
-        """
-        self.check_objective_present(posteriors, datasets)
-
-        objective_posterior = posteriors[OBJECTIVE]
-        if not isinstance(objective_posterior, ConjugatePosterior):
-            raise ValueError(
-                "Objective posterior must be a ConjugatePosterior to draw an approximate sample."
-            )
-
-        objective_dataset = datasets[OBJECTIVE]
-        thompson_sample = objective_posterior.sample_approx(
-            num_samples=1,
-            train_data=objective_dataset,
-            key=key,
-            num_features=self.num_features,
-        )
-
-        return lambda x: -1.0 * thompson_sample(x)  # Utility functions are *maximised*

gpjax/decision_making/utility_maximizer.py

@@ -1,157 +0,0 @@
-# Copyright 2023 The JaxGaussianProcesses Contributors. All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-# ==============================================================================
-from abc import (
-    ABC,
-    abstractmethod,
-)
-from dataclasses import dataclass
-
-import jax.numpy as jnp
-import jax.random as jr
-from jaxopt import ScipyBoundedMinimize
-
-from gpjax.decision_making.search_space import (
-    AbstractSearchSpace,
-    ContinuousSearchSpace,
-)
-from gpjax.decision_making.utility_functions import SinglePointUtilityFunction
-from gpjax.typing import (
-    Array,
-    Float,
-    KeyArray,
-    ScalarFloat,
-)
-
-
-def _get_discrete_maximizer(
-    query_points: Float[Array, "N D"], utility_function: SinglePointUtilityFunction
-) -> Float[Array, "1 D"]:
-    """Get the point which maximises the utility function evaluated at a given set of points.
-
-    Args:
-        query_points: set of points at which to evaluate the utility function, as an array
-            of shape `[n_points, n_dims]`.
-        utility_function: the single point utility function to be evaluated at `query_points`.
-
-    Returns:
-        Array of shape `[1, n_dims]` representing the point which maximises the utility function.
-    """
-    utility_function_values = utility_function(query_points)
-    max_utility_function_value_idx = jnp.argmax(
-        utility_function_values, axis=0, keepdims=True
-    )
-    best_sample_point = jnp.take_along_axis(
-        query_points, max_utility_function_value_idx, axis=0
-    )
-    return best_sample_point
-
-
-@dataclass
-class AbstractSinglePointUtilityMaximizer(ABC):
-    """Abstract base class for single point utility function maximizers."""
-
-    @abstractmethod
-    def maximize(
-        self,
-        utility_function: SinglePointUtilityFunction,
-        search_space: AbstractSearchSpace,
-        key: KeyArray,
-    ) -> Float[Array, "1 D"]:
-        """Maximize the given utility function over the search space provided.
-
-        Args:
-            utility_function: utility function to be maximized.
-            search_space: search space over which to maximize the utility function.
-            key: JAX PRNG key.
-
-        Returns:
-            Float[Array, "1 D"]: Point at which the utility function is maximized.
-        """
-        raise NotImplementedError
-
-
-@dataclass
-class ContinuousSinglePointUtilityMaximizer(AbstractSinglePointUtilityMaximizer):
-    """The `ContinuousUtilityMaximizer` class is used to maximize utility
-    functions over the continuous domain with L-BFGS-B. First we sample the utility
-    function at `num_initial_samples` points from the search space, and then we run
-    L-BFGS-B from the best of these initial points. We run this process `num_restarts`
-    number of times, each time sampling a different random set of
-    `num_initial_samples`initial points.
-    """
-
-    num_initial_samples: int
-    num_restarts: int
-
-    def __post_init__(self):
-        if self.num_initial_samples < 1:
-            raise ValueError(
-                f"num_initial_samples must be greater than 0, got {self.num_initial_samples}."
-            )
-        elif self.num_restarts < 1:
-            raise ValueError(
-                f"num_restarts must be greater than 0, got {self.num_restarts}."
-            )
-
-    def maximize(
-        self,
-        utility_function: SinglePointUtilityFunction,
-        search_space: ContinuousSearchSpace,
-        key: KeyArray,
-    ) -> Float[Array, "1 D"]:
-        max_observed_utility_function_value = None
-        maximizer = None
-
-        for _ in range(self.num_restarts):
-            key, _ = jr.split(key)
-            initial_sample_points = search_space.sample(
-                self.num_initial_samples, key=key
-            )
-            best_initial_sample_point = _get_discrete_maximizer(
-                initial_sample_points, utility_function
-            )
-
-            def _scalar_utility_function(x: Float[Array, "1 D"]) -> ScalarFloat:
-                """
-                The Jaxopt minimizer requires a function which returns a scalar. It calls the
-                utility function with one point at a time, so the utility function
-                returns an array of shape [1, 1], so  we index to return a scalar. Note that
-                we also return the negative of the utility function - this is because
-                utility functions should be *maximimized* but the Jaxopt minimizer
-                minimizes functions.
-                """
-                return -utility_function(x)[0][0]
-
-            lbfgsb = ScipyBoundedMinimize(
-                fun=_scalar_utility_function, method="l-bfgs-b"
-            )
-            bounds = (search_space.lower_bounds, search_space.upper_bounds)
-            optimized_point = lbfgsb.run(
-                best_initial_sample_point, bounds=bounds
-            ).params
-            optimized_utility_function_value = _scalar_utility_function(optimized_point)
-            if (max_observed_utility_function_value is None) or (
-                optimized_utility_function_value > max_observed_utility_function_value
-            ):
-                max_observed_utility_function_value = optimized_utility_function_value
-                maximizer = optimized_point
-        return maximizer
-
-
-AbstractUtilityMaximizer = AbstractSinglePointUtilityMaximizer
-"""
-Type alias for a utility maximizer. Currently we only support single point utility
-functions, but in future may support batched utility functions.
-"""

gpjax/decision_making/utils.py

@@ -1,64 +0,0 @@
-# Copyright 2023 The JaxGaussianProcesses Contributors. All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-# ==============================================================================
-from beartype.typing import (
-    Callable,
-    Dict,
-    Final,
-)
-import jax.numpy as jnp
-
-from gpjax.dataset import Dataset
-from gpjax.gps import AbstractPosterior
-from gpjax.typing import (
-    Array,
-    Float,
-)
-
-OBJECTIVE: Final[str] = "OBJECTIVE"
-"""
-Tag for the objective dataset/function in standard utility functions.
-"""
-
-
-FunctionEvaluator = Callable[[Float[Array, "N D"]], Dict[str, Dataset]]
-"""
-Type alias for function evaluators, which take an array of points of shape $[N, D]$
-and evaluate a set of functions at each point, returning a mapping from function tags
-to datasets of the evaluated points. This is the same as the `Observer` in Trieste:
-https://github.com/secondmind-labs/trieste/blob/develop/trieste/observer.py
-"""
-
-
-def build_function_evaluator(
-    functions: Dict[str, Callable[[Float[Array, "N D"]], Float[Array, "N 1"]]],
-) -> FunctionEvaluator:
-    """
-    Takes a dictionary of functions and returns a `FunctionEvaluator` which can be
-    used to evaluate each of the functions at a supplied set of points and return a
-    dictionary of datasets storing the evaluated points.
-    """
-    return lambda x: {tag: Dataset(x, f(x)) for tag, f in functions.items()}
-
-
-def get_best_latent_observation_val(
-    posterior: AbstractPosterior, dataset: Dataset
-) -> Float[Array, ""]:
-    """
-    Takes a posterior and dataset and returns the best (latent) function value in the
-    dataset, corresponding to the minimum of the posterior mean value evaluated at
-    locations in the dataset. In the noiseless case, this corresponds to the minimum
-    value in the dataset.
-    """
-    return jnp.min(posterior(dataset.X, dataset).mean())

gpjax-0.9.3.dist-info/licenses/LICENSE

@@ -1,201 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "{}"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright {yyyy} {name of copyright owner}
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.