Skip to content

Commit 817bde0

Browse files
committed
Added docs
1 parent da9c13d commit 817bde0

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

docs/src/api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ kernelmatrix!
5959
kerneldiagmatrix
6060
kerneldiagmatrix!
6161
kernelpdmat
62+
kernelkronmat
6263
transform
6364
```
6465

docs/src/userguide.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ For example:
2222
kernelmatrix(k,A,obsdim=2) # Return a 5x5 matrix
2323
```
2424

25+
We also support specific kernel matrices outputs:
26+
- For a positive-definite matrix object`PDMat` from [`PDMats.jl`](https://github.com/JuliaStats/PDMats.jl). Call `kernelpdmat(k,A,obsdim=1)`, it will create a matrix and in case of bad conditionning will add some diagonal noise until the matrix is considered PSD, it will then return a `PDMat` object. For this method to work in your code you need to include `using PDMats` first
27+
- For a Kronecker matrix, we rely on [`Kronecker.jl`](https://github.com/MichielStock/Kronecker.jl). We give two methods : `kernelkronmat(k,[x,y,z])` where `x` `y` and `z` are vectors, and `kernelkronmat(k,x,dims)` where `x` is a vector and dims and the number of features. Make sure that `k` is a vector compatible with such constructions (with `iskroncompatible`).For this method to work in your code you need to include `using Kronecker` first
28+
2529
## Kernel manipulation
2630

2731
One can create combinations of kernels via `KernelSum` and `KernelProduct` or using simple operators `+` and `*`.

0 commit comments

Comments
 (0)