Skip to content

Commit f667606

Browse files
fixing index.md
1 parent 1c9eccb commit f667606

File tree

1 file changed

+52
-18
lines changed

1 file changed

+52
-18
lines changed

docs/src/index.md

Lines changed: 52 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,49 @@
11
# ReservoirComputing.jl
22

3-
ReservoirComputing.jl is a versatile and user-friendly Julia package designed for the implementation of advanced Reservoir Computing models, such as Echo State Networks (ESNs). Central to Reservoir Computing is the expansion of input data into a higher-dimensional space, leveraging regression techniques for effective model training. This approach bears resemblance to kernel methods, offering a unique perspective in machine learning. ReservoirComputing.jl offers a modular design, ensuring both ease of use for newcomers and flexibility for advanced users, establishing it as a key tool for innovative computing solutions.
3+
ReservoirComputing.jl is a versatile and user-friendly Julia package designed
4+
for the implementation of Reservoir Computing models, such as Echo State Networks (ESNs).
5+
Reservoir Computing expands the input data into a higher-dimensional
6+
space, leveraging regression techniques for effective model training.
7+
This approach can be thought as a kernel method with an explicit kernel trick.
48

59
!!! info "Introductory material"
610

7-
This library assumes some basic knowledge of Reservoir Computing. For a good introduction, we suggest the following papers: the first two are the seminal papers about ESN and LSM, the others are in-depth review papers that should cover all the needed information. For the majority of the algorithms implemented in this library we cited in the documentation the original work introducing them. If you ever are in doubt about a method or a function just type `? function` in the Julia REPL to read the relevant notes.
11+
This library assumes some basic knowledge of Reservoir Computing.
12+
For a good introduction, we suggest the following papers:
13+
the first two are the seminal papers about ESN and liquid state machines,
14+
the others are in-depth review papers that should cover all the needed
15+
information. For the majority of the algorithms implemented in this library
16+
we cited in the documentation the original work introducing them.
17+
If you ever are in doubt about a method or a function just type `? function`
18+
in the Julia REPL to read the relevant notes.
819

9-
- Jaeger, Herbert: The “echo state” approach to analyzing and training recurrent neural networks-with an erratum note.
10-
- Maass W, Natschläger T, Markram H: Real-time computing without stable states: a new framework for neural computation based on perturbations.
11-
- Lukoševičius, Mantas: A practical guide to applying echo state networks." Neural networks: Tricks of the trade.
12-
- Lukoševičius, Mantas, and Herbert Jaeger: Reservoir computing approaches to recurrent neural network training.
20+
- Jaeger, Herbert: The “echo state” approach to analyzing and training
21+
recurrent neural networks-with an erratum note.
22+
- Maass W, Natschläger T, Markram H: Real-time computing without
23+
stable states: a new framework for neural computation based on
24+
perturbations.
25+
- Lukoševičius, Mantas: A practical guide to applying echo state networks.
26+
Neural networks: Tricks of the trade.
27+
- Lukoševičius, Mantas, and Herbert Jaeger: Reservoir computing approaches
28+
to recurrent neural network training.
1329

1430
!!! info "Performance tip"
1531

16-
For faster computations on the CPU it is suggested to add `using MKL` to the script. For clarity's sake this library will not be indicated under every example in the documentation.
32+
For faster computations on the CPU it is suggested to add `using MKL`
33+
to the script. For clarity's sake this library will not be indicated
34+
under every example in the documentation.
1735

1836
## Installation
1937

20-
To install ReservoirComputing.jl, ensure you have Julia version 1.6 or higher. Follow these steps:
38+
To install ReservoirComputing.jl, ensure you have Julia version 1.10 or higher.
39+
Follow these steps:
2140

2241
1. Open the Julia command line.
2342
2. Enter the Pkg REPL mode by pressing ].
24-
3. Type add ReservoirComputing and press Enter.
43+
3. Type `add ReservoirComputing` and press Enter.
2544

26-
For a more customized installation or to contribute to the package, consider cloning the repository:
45+
For a more customized installation or to contribute to the package,
46+
consider cloning the repository:
2747

2848
```julia
2949
using Pkg
@@ -34,20 +54,34 @@ or `dev` the package.
3454

3555
## Features Overview
3656

37-
- **Multiple Training Algorithms**: Supports Ridge Regression, Linear Models, and LIBSVM regression methods for Reservoir Computing models.
38-
- **Diverse Prediction Methods**: Offers both generative and predictive methods for Reservoir Computing predictions.
39-
- **Modifiable Training and Prediction**: Allows modifications in Reservoir Computing states, such as state extension, padding, and combination methods.
40-
- **Non-linear Algorithm Options**: Includes options for non-linear modifications in algorithms.
41-
- **Echo State Networks (ESNs)**: Features various input layers, reservoirs, and methods for driving ESN reservoir states.
42-
- **Cellular Automata-Based Reservoir Computing**: Introduces models based on one-dimensional Cellular Automata for Reservoir Computing.
57+
- **Multiple Training Algorithms**: Supports Ridge Regression, Linear Models,
58+
and LIBSVM regression methods for Reservoir Computing models.
59+
- **Diverse Prediction Methods**: Offers both generative and predictive methods
60+
for Reservoir Computing predictions.
61+
- **Modifiable Training and Prediction**: Allows modifications in Reservoir
62+
Computing states, such as state extension, padding, and combination methods.
63+
- **Non-linear Algorithm Options**: Includes options for non-linear
64+
modifications in algorithms.
65+
- **Echo State Networks (ESNs)**: Features various input layers, reservoirs,
66+
and methods for driving ESN reservoir states.
67+
- **Cellular Automata-Based Reservoir Computing**: Introduces models based
68+
on one-dimensional Cellular Automata for Reservoir Computing.
4369

4470
## Contributing
4571

46-
Contributions to ReservoirComputing.jl are highly encouraged and appreciated. Whether it's through implementing new RC model variations, enhancing documentation, adding examples, or any improvement, your contribution is valuable. We welcome posts of relevant papers or ideas in the issues section. For deeper insights into the library's functionality, the API section in the documentation is a great resource. For any queries not suited for issues, please reach out to the lead developers via Slack or email.
72+
Contributions to ReservoirComputing.jl are highly encouraged and appreciated.
73+
Whether it's through implementing new RC model variations,
74+
enhancing documentation, adding examples, or any improvement,
75+
your contribution is valuable.
76+
We welcome posts of relevant papers or ideas in the issues section.
77+
For deeper insights into the library's functionality, the API section in the
78+
documentation is a great resource. For any queries not suited for issues,
79+
please reach out to the lead developers via Slack or email.
4780

4881
## Citing
4982

50-
If you use ReservoirComputing.jl in your work, we kindly ask you to cite it. Here is the BibTeX entry for your convenience:
83+
If you use ReservoirComputing.jl in your work, we kindly ask you to cite it.
84+
Here is the BibTeX entry for your convenience:
5185

5286
```bibtex
5387
@article{JMLR:v23:22-0611,

0 commit comments

Comments
 (0)