From f351caa4758208b31f4eab7300179f97c0b8da8e Mon Sep 17 00:00:00 2001 From: lukashergt Date: Mon, 11 Mar 2024 18:13:20 -0700 Subject: [PATCH] add links to NDE paper --- anesthetic/plot.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/anesthetic/plot.py b/anesthetic/plot.py index 29eeb115..2283533e 100644 --- a/anesthetic/plot.py +++ b/anesthetic/plot.py @@ -980,6 +980,8 @@ def nde_plot_1d(ax, data, *args, **kwargs): This functions as a wrapper around :meth:`matplotlib.axes.Axes.plot`, with a normalising flow as a neural density estimation (NDE) provided by :class:`margarine.maf.MAF` or :class:`margarine.clustered.clusterMAF`. + See also `Bevins et al. (2022) `_. + All remaining keyword arguments are passed onwards. Parameters @@ -1487,6 +1489,8 @@ def nde_contour_plot_2d(ax, data_x, data_y, *args, **kwargs): and :meth:`matplotlib.axes.Axes.contourf` with a normalising flow as a neural density estimator (NDE) provided by :class:`margarine.maf.MAF` or :class:`margarine.clustered.clusterMAF`. + See also `Bevins et al. (2022) `_. + All remaining keyword arguments are passed onwards to both functions. Parameters @@ -1597,7 +1601,7 @@ def nde_contour_plot_2d(ax, data_x, data_y, *args, **kwargs): from margarine.clustered import clusterMAF except ImportError: - raise ImportError("Please install margarine to use nde_1d") + raise ImportError("Please install margarine to use nde_2d") if nde_clustering: nde = clusterMAF(data, weights=w, lr=nde_lr,