Skip to content
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

Jump to bottom

Small needed docs changes #132

Closed
wants to merge 2 commits into from
Closed

Small needed docs changes #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7109779
added performance tips, added indication about gp in v0.9
MartinuzziFrancesco Aug 23, 2022
0a9fe2e
some fixes
MartinuzziFrancesco Aug 28, 2022
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 docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The support for this library is for Julia v1.6 or greater.
This library provides multiple ways of training the chosen RC model. More specifically the available algorithms are:
- ```StandardRidge```: a naive implementation of Ridge Regression. The default choice for training.
- ```LinearModel```: a wrap around [MLJLinearModels](https://juliaai.github.io/MLJLinearModels.jl/stable/).
- ```GaussianProcess```: a wrap around [GaussianProcesses](http://stor-i.github.io/GaussianProcesses.jl/latest/).
- ```GaussianProcess```: a wrap around [GaussianProcesses](http://stor-i.github.io/GaussianProcesses.jl/latest/). Currently not available in version 0.9.0. Alternatives are being explored
- ```LIBSVM.AbstractSVR```: a direct call of [LIBSVM](https://github.com/JuliaML/LIBSVM.jl) regression methods.

Also provided are two different ways of doing predictions using RC:
Expand Down
2 changes: 1 addition & 1 deletion src/ReservoirComputing.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export AbstractLayer, create_layer
export WeightedLayer, DenseLayer, SparseLayer, MinimumLayer, InformedLayer, NullLayer
export BernoulliSample, IrrationalSample
export GaussianProcess
export AbstractReservoir, create_reservoir
export AbstractReservoir, create_reservoir, create_states
export RandSparseReservoir, PseudoSVDReservoir, DelayLineReservoir
export DelayLineBackwardReservoir, SimpleCycleReservoir, CycleJumpsReservoir, NullReservoir
export RNN, MRNN, GRU, GRUParams, FullyGated, Variant1, Variant2, Variant3, Minimal
Expand Down
9 changes: 6 additions & 3 deletions src/esn/esn_reservoir_drivers.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
abstract type AbstractReservoirDriver end

"""
create_states(
reservoir_driver::AbstractReservoirDriver, train_data, reservoir_matrix,input_matrix
)
create_states(reservoir_driver::AbstractReservoirDriver,
train_data,
washout,
reservoir_matrix,
input_matrix,
bias_vector)

Return the trained ESN states according to the given driver.
"""
Expand Down