-
-
Notifications
You must be signed in to change notification settings - Fork 60
Implement Laplace (quadratic) approximation #345
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
56abf7d
First draft of quadratic approximation
carsten-j 8d3f0a1
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 50ee3f4
Review comments incorporated
carsten-j 7d63b26
License and copyright information added
carsten-j 262f86f
Only add additional data to inferencedata when chains!=0
carsten-j 924352b
Raise error if Hessian is singular
carsten-j 0ba4b55
Replace for loop with call to remove_value_transforms
carsten-j 0d7d4be
Pass model directly when finding MAP and the Hessian
carsten-j 45cf590
Update pymc_experimental/inference/laplace.py
carsten-j 35c068e
Remove chains from public parameters for Laplace approx method
carsten-j 071b04b
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 5f0cc28
Parameter draws is not optional with default value 1000
carsten-j f8fc0e2
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 9fa3295
Add warning if numbers of variables in vars does not equal number of …
carsten-j ee2f7d5
Update version.txt
ricardoV94 d96940a
`shock_size` should never be scalar
jessegrabowski ffd706d
Blackjax API change
ricardoV94 52bc191
Handle latest PyMC/PyTensor breaking changes
ricardoV94 ab6ed2b
Temporarily mark two tests as xfail
ricardoV94 e0bfcfc
More bugfixes for statespace (#346)
jessegrabowski 10f7164
Fix failing test case for laplace
carsten-j File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,190 @@ | ||
# Copyright 2024 The PyMC Developers | ||
# | ||
# 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. | ||
|
||
import warnings | ||
from collections.abc import Sequence | ||
from typing import Optional | ||
|
||
import arviz as az | ||
import numpy as np | ||
import pymc as pm | ||
import xarray as xr | ||
from arviz import dict_to_dataset | ||
from pymc.backends.arviz import ( | ||
coords_and_dims_for_inferencedata, | ||
find_constants, | ||
find_observations, | ||
) | ||
from pymc.model.transform.conditioning import remove_value_transforms | ||
from pymc.util import RandomSeed | ||
from pytensor import Variable | ||
|
||
|
||
def laplace( | ||
vars: Sequence[Variable], | ||
draws: Optional[int] = 1000, | ||
model=None, | ||
random_seed: Optional[RandomSeed] = None, | ||
progressbar=True, | ||
): | ||
""" | ||
Create a Laplace (quadratic) approximation for a posterior distribution. | ||
|
||
This function generates a Laplace approximation for a given posterior distribution using a specified | ||
number of draws. This is useful for obtaining a parametric approximation to the posterior distribution | ||
that can be used for further analysis. | ||
|
||
Parameters | ||
---------- | ||
vars : Sequence[Variable] | ||
A sequence of variables for which the Laplace approximation of the posterior distribution | ||
is to be created. | ||
draws : Optional[int] with default=1_000 | ||
The number of draws to sample from the posterior distribution for creating the approximation. | ||
For draws=None only the fit of the Laplace approximation is returned | ||
model : object, optional, default=None | ||
The model object that defines the posterior distribution. If None, the default model will be used. | ||
random_seed : Optional[RandomSeed], optional, default=None | ||
An optional random seed to ensure reproducibility of the draws. If None, the draws will be | ||
generated using the current random state. | ||
progressbar: bool, optional defaults to True | ||
Whether to display a progress bar in the command line. | ||
|
||
Returns | ||
------- | ||
arviz.InferenceData | ||
An `InferenceData` object from the `arviz` library containing the Laplace | ||
approximation of the posterior distribution. The inferenceData object also | ||
contains constant and observed data as well as deterministic variables. | ||
InferenceData also contains a group 'fit' with the mean and covariance | ||
for the Laplace approximation. | ||
|
||
Examples | ||
-------- | ||
|
||
>>> import numpy as np | ||
>>> import pymc as pm | ||
>>> import arviz as az | ||
>>> from pymc_experimental.inference.laplace import laplace | ||
>>> y = np.array([2642, 3503, 4358]*10) | ||
>>> with pm.Model() as m: | ||
>>> logsigma = pm.Uniform("logsigma", 1, 100) | ||
>>> mu = pm.Uniform("mu", -10000, 10000) | ||
>>> yobs = pm.Normal("y", mu=mu, sigma=pm.math.exp(logsigma), observed=y) | ||
>>> idata = laplace([mu, logsigma], model=m) | ||
|
||
Notes | ||
----- | ||
This method of approximation may not be suitable for all types of posterior distributions, | ||
especially those with significant skewness or multimodality. | ||
|
||
See Also | ||
-------- | ||
fit : Calling the inference function 'fit' like pmx.fit(method="laplace", vars=[mu, logsigma], model=m) | ||
will forward the call to 'laplace'. | ||
|
||
""" | ||
|
||
rng = np.random.default_rng(seed=random_seed) | ||
|
||
transformed_m = pm.modelcontext(model) | ||
|
||
if len(vars) != len(transformed_m.free_RVs): | ||
warnings.warn( | ||
"Number of variables in vars does not eqaul the number of variables in the model.", | ||
UserWarning, | ||
) | ||
|
||
map = pm.find_MAP(vars=vars, progressbar=progressbar, model=transformed_m) | ||
|
||
# See https://www.pymc.io/projects/docs/en/stable/api/model/generated/pymc.model.transform.conditioning.remove_value_transforms.html | ||
untransformed_m = remove_value_transforms(transformed_m) | ||
untransformed_vars = [untransformed_m[v.name] for v in vars] | ||
hessian = pm.find_hessian(point=map, vars=untransformed_vars, model=untransformed_m) | ||
|
||
if np.linalg.det(hessian) == 0: | ||
raise np.linalg.LinAlgError("Hessian is singular.") | ||
|
||
cov = np.linalg.inv(hessian) | ||
mean = np.concatenate([np.atleast_1d(map[v.name]) for v in vars]) | ||
|
||
chains = 1 | ||
|
||
if draws is not None: | ||
samples = rng.multivariate_normal(mean, cov, size=(chains, draws)) | ||
|
||
data_vars = {} | ||
for i, var in enumerate(vars): | ||
data_vars[str(var)] = xr.DataArray(samples[:, :, i], dims=("chain", "draw")) | ||
|
||
coords = {"chain": np.arange(chains), "draw": np.arange(draws)} | ||
ds = xr.Dataset(data_vars, coords=coords) | ||
|
||
idata = az.convert_to_inference_data(ds) | ||
idata = addDataToInferenceData(model, idata, progressbar) | ||
else: | ||
idata = az.InferenceData() | ||
|
||
idata = addFitToInferenceData(vars, idata, mean, cov) | ||
|
||
return idata | ||
|
||
|
||
def addFitToInferenceData(vars, idata, mean, covariance): | ||
coord_names = [v.name for v in vars] | ||
# Convert to xarray DataArray | ||
mean_dataarray = xr.DataArray(mean, dims=["rows"], coords={"rows": coord_names}) | ||
cov_dataarray = xr.DataArray( | ||
covariance, dims=["rows", "columns"], coords={"rows": coord_names, "columns": coord_names} | ||
) | ||
|
||
# Create xarray dataset | ||
dataset = xr.Dataset({"mean_vector": mean_dataarray, "covariance_matrix": cov_dataarray}) | ||
|
||
idata.add_groups(fit=dataset) | ||
|
||
return idata | ||
|
||
|
||
def addDataToInferenceData(model, trace, progressbar): | ||
# Add deterministic variables to inference data | ||
trace.posterior = pm.compute_deterministics( | ||
trace.posterior, model=model, merge_dataset=True, progressbar=progressbar | ||
) | ||
|
||
coords, dims = coords_and_dims_for_inferencedata(model) | ||
|
||
observed_data = dict_to_dataset( | ||
find_observations(model), | ||
library=pm, | ||
coords=coords, | ||
dims=dims, | ||
default_dims=[], | ||
) | ||
|
||
constant_data = dict_to_dataset( | ||
find_constants(model), | ||
library=pm, | ||
coords=coords, | ||
dims=dims, | ||
default_dims=[], | ||
) | ||
|
||
trace.add_groups( | ||
{"observed_data": observed_data, "constant_data": constant_data}, | ||
coords=coords, | ||
dims=dims, | ||
) | ||
|
||
return trace |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.