Skip to content

Commit 6f7be06

Browse files
authored
Merge pull request #119 from theogf/fix_docs
Fixing some documentation bugs
2 parents 86d430c + 5dbf881 commit 6f7be06

File tree

10 files changed

+194
-66
lines changed

10 files changed

+194
-66
lines changed

.github/workflows/CompatHelper.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ jobs:
1616
- name: CompatHelper.main()
1717
env:
1818
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
19-
run: julia -e 'using CompatHelper; CompatHelper.main(; subdirs = ["", "test"])'
19+
run: julia -e 'using CompatHelper; CompatHelper.main(; subdirs = ["", "docs", "test"])'

docs/Project.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
11
[deps]
22
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
4+
[compat]
5+
Documenter = "0.23, 0.24"

docs/src/api.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,24 +14,34 @@ CurrentModule = KernelFunctions
1414
KernelFunctions
1515
```
1616

17-
## Base Kernels
17+
## Base Kernels API
1818

1919
```@docs
20+
ConstantKernel
21+
WhiteKernel
22+
EyeKernel
23+
ZeroKernel
24+
CosineKernel
2025
SqExponentialKernel
2126
ExponentialKernel
2227
GammaExponentialKernel
2328
ExponentiatedKernel
29+
FBMKernel
30+
GaborKernel
2431
MaternKernel
2532
Matern32Kernel
2633
Matern52Kernel
34+
NeuralNetworkKernel
2735
LinearKernel
2836
PolynomialKernel
37+
PiecewisePolynomialKernel
38+
MahalanobisKernel
2939
RationalQuadraticKernel
3040
GammaRationalQuadraticKernel
41+
spectral_mixture_kernel
42+
spectral_mixture_product_kernel
3143
PeriodicKernel
32-
ZeroKernel
33-
ConstantKernel
34-
WhiteKernel
44+
WienerKernel
3545
```
3646

3747
## Composite Kernels
@@ -41,6 +51,7 @@ TransformedKernel
4151
ScaledKernel
4252
KernelSum
4353
KernelProduct
54+
TensorProduct
4455
```
4556

4657
## Transforms
@@ -49,8 +60,10 @@ KernelProduct
4960
Transform
5061
IdentityTransform
5162
ScaleTransform
52-
LowRankTransform
63+
ARDTransform
64+
LinearTransform
5365
FunctionTransform
66+
SelectTransform
5467
ChainTransform
5568
```
5669

@@ -63,9 +76,17 @@ kerneldiagmatrix
6376
kerneldiagmatrix!
6477
kernelpdmat
6578
kernelkronmat
79+
nystrom
6680
transform
6781
```
6882

83+
## Utilities
84+
85+
```@docs
86+
ColVecs
87+
RowVecs
88+
NystromFact
89+
```
6990

7091
## Index
7192

0 commit comments

Comments
 (0)