Skip to content

Use only docstrings in documentation + fix them #236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
Jan 19, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name = "KernelFunctions"
uuid = "ec8451be-7e33-11e9-00cf-bbf324bd1392"
version = "0.8.16"
version = "0.8.17"

[deps]
Compat = "34da2185-b29b-5c13-b0c7-acf172513d20"
Expand Down
58 changes: 1 addition & 57 deletions docs/src/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,63 +9,6 @@ Pages = ["api.md"]
CurrentModule = KernelFunctions
```

## Module
```@docs
KernelFunctions
```

## Base Kernels API

```@docs
ConstantKernel
WhiteKernel
EyeKernel
ZeroKernel
CosineKernel
SqExponentialKernel
ExponentialKernel
GammaExponentialKernel
ExponentiatedKernel
FBMKernel
GaborKernel
MaternKernel
Matern32Kernel
Matern52Kernel
NeuralNetworkKernel
LinearKernel
PolynomialKernel
PiecewisePolynomialKernel
RationalQuadraticKernel
GammaRationalQuadraticKernel
spectral_mixture_kernel
spectral_mixture_product_kernel
PeriodicKernel
WienerKernel
```

## Composite Kernels

```@docs
TransformedKernel
ScaledKernel
KernelSum
KernelProduct
TensorProduct
```

## Transforms

```@docs
Transform
IdentityTransform
ScaleTransform
ARDTransform
LinearTransform
FunctionTransform
SelectTransform
ChainTransform
```

## Functions

```@docs
Expand All @@ -84,6 +27,7 @@ transform
```@docs
ColVecs
RowVecs
MOInput
NystromFact
```

Expand Down
Loading