Skip to content

Commit

Permalink
Fixed a few typos in the docs (#219)
Browse files Browse the repository at this point in the history
* Update README.md

Fixed a few typos.

* Update script.jl

Fix a typo

* Update examples/getting_started/script.jl

Co-authored-by: willtebbutt <[email protected]>

Co-authored-by: willtebbutt <[email protected]>
  • Loading branch information
pitmonticone and willtebbutt authored Dec 28, 2021
1 parent 2510d49 commit 469b049
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Examples Overview

There are numerous examples of things that can be done with Stheno.jl in this directory. The `getting_started` sub-directory, you should have the pre-requisites to understand the other folders, each of while build on `getting_started` in
There are numerous examples of things that can be done with Stheno.jl in this directory. The `getting_started` sub-directory, you should have the pre-requisites to understand the other folders, each of which build on `getting_started`.

Note that each sub-directory contains its own environment that specifies a particular version of Stheno and other dependencies. As such, each example _should_ certainly be runnable. It might not, however, be runnable on the most recent version of Stheno. If you encounter this, it likely means that someone forgot to check that all of the examples still run when a breaking change was made. This should be considered a bug and an issue raised, or PR open to fix the problem!

Expand All @@ -9,6 +9,6 @@ Below we provide a brief description of each of the sub-directories.
- `getting_started`: the most fundamental Stheno.jl functionality. If you're not comfortable with the content of this folder, you likely won't be with the rest of them.
- `pseudo_points`: covers inducing-point / sparse / pseudo-point approximations.
- `basic_gppp`: basic toy examples of the functionality that we call Gaussian process Probabilistic Programming (GPPP).
- `gppp_and_pseudo_points`: combine GPPP and pseudo-point approximations to do interesting things. This is a WIP -- it doesn't work properly yet.
- `flux_integration`: indicate how Stheno.jl work with Flux.jl. Currently we have an example shows how to use Flux's neural network as a feature extractor and then use GP to do regression, Stheno's power is not limited to this, we are working on adding more functionalities and more examples.
- `gppp_and_pseudo_points`: combines GPPP and pseudo-point approximations to do interesting things. This is a WIP -- it doesn't work properly yet.
- `flux_integration`: indicates how Stheno.jl works with Flux.jl. Currently we have an example showing how to use Flux's neural network as a feature extractor and then use GP to do regression, Stheno's power is not limited to this, we are working on adding more functionalities and more examples.
- `turing_integration`: a binary classification example shows how Stheno.jl, with the help of Turing.jl, can be used in non-Gaussian likelihood problems.
2 changes: 1 addition & 1 deletion examples/getting_started/script.jl
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# # Getting Started
#
# Here we document how to do some basic stuff, including learning and inference in kernel parameters, with Stheno.jl. To do this, we that makes use of a variety of packages from the Julia ecosystem. In particular, we'll make use of
# Here we document how to do some basic stuff, including learning and inference in kernel parameters, with Stheno.jl. To do this, we make use of a variety of packages from the Julia ecosystem:
# - [AdvancedHMC.jl](https://github.com/TuringLang/AdvancedHMC.jl) to perform Bayesian inference in our model parameters,
# - [Optim.jl](https://github.com/JuliaNLSolvers/Optim.jl) for point-estimates of our model parameters,
# - [ParameterHandling.jl](https://github.com/invenia/ParameterHandling.jl) to make it easy to work with our model's parameters, and to ensure that it plays nicely with Optim and AdvancedHMC,
Expand Down

0 comments on commit 469b049

Please sign in to comment.