Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Rheinwalt authored Jun 29, 2023
1 parent 59ab876 commit cf726c6
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,18 @@
# gaussian_kde_gpu
GPU Gaussian kernel density estimation

## GPU Gaussian kernel density estimation

The provided function `gaussian_kde_gpu()` is a simplified version of Scipy's `gaussian_kde`. It does not support weights and only uses the default Scott's Rule for bandwidth estimation. However, it leverages the computative power of a CUDA supported GPU via Numba. Given the random variable `p` it will estimate the probability density function (PDF) at query point `q` in the following way:

``` {.python .numberLines}
from gaussian_kde_gpu import gaussian_kde_gpu
density = = gaussian_kde_gpu(p, q)
```

For more details see [tutorial](GPU_Gaussian_kernel_density_estimation.ipynb).

### Requirements

- Numpy
- Numba

0 comments on commit cf726c6

Please sign in to comment.