Skip to content

Commit b354702

Browse files
some docs fies
1 parent 655cac4 commit b354702

File tree

3 files changed

+43
-15
lines changed

3 files changed

+43
-15
lines changed

src/ReservoirComputing.jl

Lines changed: 40 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,25 @@ end
4545
"""
4646
Generative(prediction_len)
4747
48-
This prediction methodology allows the models to produce an autonomous prediction, feeding the prediction into itself to generate the next step.
49-
The only parameter needed is the number of steps for the prediction.
48+
A prediction strategy that enables models to generate autonomous multi-step
49+
forecasts by recursively feeding their own outputs back as inputs for
50+
subsequent prediction steps.
51+
52+
# Parameters
53+
- `prediction_len::Int`: The number of future steps to predict.
54+
55+
# Description
56+
57+
The `Generative` prediction method allows a model to perform multi-step
58+
forecasting by using its own previous predictions as inputs for future predictions.
59+
This approach is especially useful in time series analysis, where each prediction
60+
depends on the preceding data points.
61+
62+
At each step, the model takes the current input, generates a prediction,
63+
and then incorporates that prediction into the input for the next step.
64+
This recursive process continues until the specified
65+
number of prediction steps (`prediction_len`) is reached.
66+
5067
"""
5168
struct Generative{T} <: AbstractPrediction
5269
prediction_len::T
@@ -60,7 +77,27 @@ end
6077
"""
6178
Predictive(prediction_data)
6279
63-
Given a set of labels as `prediction_data`, this method of prediction will return the corresponding labels in a standard Machine Learning fashion.
80+
A prediction strategy for supervised learning tasks,
81+
where a model predicts labels based on a provided set
82+
of input features (`prediction_data`).
83+
84+
# Parameters
85+
- `prediction_data`: The input data used for prediction, typically structured as a matrix
86+
where each column represents a sample, and each row represents a feature.
87+
88+
# Description
89+
90+
The `Predictive` prediction method is a standard approach
91+
in supervised machine learning tasks. It uses the provided input data
92+
(`prediction_data`) to produce corresponding labels or outputs based
93+
on the learned relationships in the model. Unlike generative prediction,
94+
this method does not recursively feed predictions into the model;
95+
instead, it operates on fixed input data to produce a single batch of predictions.
96+
97+
This method is suitable for tasks like classification,
98+
regression, or other use cases where the input features
99+
and the number of steps are predefined.
100+
64101
"""
65102
function Predictive(prediction_data)
66103
prediction_len = size(prediction_data, 2)

src/esn/deepesn.jl

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,6 @@ temporal features.
5555
- `matrix_type`: The type of matrix used for storing the training data.
5656
Default is inferred from `train_data`.
5757
58-
# Returns
59-
60-
- A `DeepESN` instance configured according to the provided parameters
61-
and suitable for further training and prediction tasks.
62-
6358
# Example
6459
6560
```julia
@@ -73,10 +68,6 @@ deepESN = DeepESN(train_data, 10, 100, depth = 3, washout = 100)
7368
train(deepESN, target_data)
7469
prediction = predict(deepESN, new_data)
7570
```
76-
77-
The DeepESN model is ideal for tasks requiring the processing of sequences with
78-
complex temporal dependencies, benefiting from the multiple reservoirs to capture
79-
different levels of abstraction and temporal dynamics.
8071
"""
8172
function DeepESN(train_data,
8273
in_size::Int,

src/esn/esn.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ Creates an Echo State Network (ESN) using specified parameters and training data
2121
2222
- `train_data`: Matrix of training data (columns as time steps, rows as features).
2323
- `variation`: Variation of ESN (default: `Default()`).
24-
- `input_layer`: Input layer of ESN (default: `DenseLayer()`).
25-
- `reservoir`: Reservoir of the ESN (default: `RandSparseReservoir(100)`).
26-
- `bias`: Bias vector for each time step (default: `NullLayer()`).
24+
- `input_layer`: Input layer of ESN.
25+
- `reservoir`: Reservoir of the ESN.
26+
- `bias`: Bias vector for each time step.
2727
- `reservoir_driver`: Mechanism for evolving reservoir states (default: `RNN()`).
2828
- `nla_type`: Non-linear activation type (default: `NLADefault()`).
2929
- `states_type`: Format for storing states (default: `StandardStates()`).

0 commit comments

Comments
 (0)