From bf87f9a2ae29ac8dcf7f211b6c076124e742fb73 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Tue, 11 Nov 2025 14:08:30 +0000 Subject: [PATCH] docs: Document weights argument for kde function Documents the `weights` argument for the `kde` function in the README and the documentation site. --- README.md | 1 + docs/src/index.md | 1 + 2 files changed, 2 insertions(+) diff --git a/README.md b/README.md index 6bad360c..3aa93418 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,7 @@ optional keyword arguments are `kernel_dist` function. * `bandwidth`: the bandwidth of the kernel. Default is to use Silverman's rule. +* `weights`: `StatsBase.Weights` vector specifying weights for each observation (defaults to uniform weights). The `UnivariateKDE` object `U` contains gridded coordinates (`U.x`) and the density estimate (`U.density`). These are typically sufficient for plotting. diff --git a/docs/src/index.md b/docs/src/index.md index abc2406d..047b15bd 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -29,6 +29,7 @@ optional keyword arguments are `kernel_dist` function. * `bandwidth`: the bandwidth of the kernel. Default is to use Silverman's rule. +* `weights`: `StatsBase.Weights` vector specifying weights for each observation (defaults to uniform weights). The `UnivariateKDE` object `U` contains gridded coordinates (`U.x`) and the density estimate (`U.density`). These are typically sufficient for plotting.