Skip to content

Fixing some documentation bugs #119

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.

Sign up for GitHub

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 9 commits into from
Jun 26, 2020
Merged

Fixing some documentation bugs #119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
922f782
Started to fix some wrong ref missing refs
theogf Jun 4, 2020
b9f5ef1
Added missing kernels in the docs
theogf Jun 4, 2020
a318d2f
Additional fixes
theogf Jun 4, 2020
5c1d51d
Added compat in Project.toml and actualized CompatHelper
theogf Jun 4, 2020
351b100
Missing compat helper
theogf Jun 4, 2020
c7b79f9
Revert "Adding Project.toml to test folder"
theogf Jun 12, 2020
8030da7
Correction kroenecker
theogf Jun 16, 2020
fb5ff94
Merge branch 'master' into fix_docs
theogf Jun 16, 2020
5dbf881
Merge branch 'master' into fix_docs
theogf Jun 24, 2020
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 .github/workflows/CompatHelper.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ jobs:
- name: CompatHelper.main()
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: julia -e 'using CompatHelper; CompatHelper.main(; subdirs = ["", "test"])'
run: julia -e 'using CompatHelper; CompatHelper.main(; subdirs = ["", "docs", "test"])'
3 changes: 3 additions & 0 deletions docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

[compat]
Documenter = "0.23, 0.24"
31 changes: 26 additions & 5 deletions docs/src/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,24 +14,34 @@ CurrentModule = KernelFunctions
KernelFunctions
```

## Base Kernels
## Base Kernels API

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

## Composite Kernels
Expand All @@ -41,6 +51,7 @@ TransformedKernel
ScaledKernel
KernelSum
KernelProduct
TensorProduct
```

## Transforms
Expand All @@ -49,8 +60,10 @@ KernelProduct
Transform
IdentityTransform
ScaleTransform
LowRankTransform
ARDTransform
LinearTransform
FunctionTransform
SelectTransform
ChainTransform
```

Expand All @@ -63,9 +76,17 @@ kerneldiagmatrix
kerneldiagmatrix!
kernelpdmat
kernelkronmat
nystrom
transform
```

## Utilities

```@docs
ColVecs
RowVecs
NystromFact
```

## Index

Expand Down
Loading