Skip to content

Commit a2d2b7d

Browse files
committed
add const alias docstrings
1 parent fafc0d2 commit a2d2b7d

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

src/basekernels/exponential.jl

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,29 @@ iskroncompatible(::SqExponentialKernel) = true
2020
Base.show(io::IO,::SqExponentialKernel) = print(io,"Squared Exponential Kernel")
2121

2222
## Aliases ##
23+
24+
"""
25+
RBFKernel()
26+
27+
See [`SqExponentialKernel`](@ref)
28+
"""
2329
const RBFKernel = SqExponentialKernel
30+
31+
"""
32+
GaussianKernel()
33+
34+
See [`SqExponentialKernel`](@ref)
35+
"""
2436
const GaussianKernel = SqExponentialKernel
37+
38+
"""
39+
SEKernel()
40+
41+
See [`SqExponentialKernel`](@ref)
42+
"""
2543
const SEKernel = SqExponentialKernel
2644

45+
2746
"""
2847
ExponentialKernel()
2948
@@ -43,9 +62,22 @@ iskroncompatible(::ExponentialKernel) = true
4362
Base.show(io::IO, ::ExponentialKernel) = print(io, "Exponential Kernel")
4463

4564
## Aliases ##
65+
66+
"""
67+
LaplacianKernel()
68+
69+
See [`ExponentialKernel`](@ref)
70+
"""
4671
const LaplacianKernel = ExponentialKernel
72+
73+
"""
74+
Matern12Kernel()
75+
76+
See [`ExponentialKernel`](@ref)
77+
"""
4778
const Matern12Kernel = ExponentialKernel
4879

80+
4981
"""
5082
GammaExponentialKernel(; γ = 2.0)
5183

0 commit comments

Comments
 (0)