Aqua + typos CI

.typos.toml

@@ -0,0 +1,2 @@
+[default.extend-words]
+ressize = "ressize"

Project.toml

@@ -18,21 +18,29 @@ Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 
 [compat]
 Adapt = "3.3.3"
+Aqua = "0.8"
 CellularAutomata = "0.0.2"
+DifferentialEquations = "7"
 Distances = "0.10"
 Distributions = "0.24, 0.25"
 LIBSVM = "0.8"
+LinearAlgebra = "1"
 MLJLinearModels = "0.5, 0.6, 0.7, 0.8, 0.9"
 NNlib = "0.8.4, 0.9"
 Optim = "1"
+Random = "1"
+SafeTestsets = "0.1"
+SparseArrays = "1"
 Statistics = "1"
+Test = "1"
 julia = "1.6"
 
 [extras]
+Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
 DifferentialEquations = "0c46a032-eb83-5123-abaf-570d42b7fbaa"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 SafeTestsets = "1bc83da4-3b8d-516f-aca4-4fe02f6d838f"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Test", "SafeTestsets", "Random", "DifferentialEquations"]
+test = ["Aqua", "Test", "SafeTestsets", "Random", "DifferentialEquations"]

README.md

@@ -62,7 +62,7 @@ output_layer = train(esn, target_data)
 output = esn(Generative(predict_len), output_layer)
 ```
 
-The data is returned as a matrix, `ouput` in the code above, that contains the predicted trajectories. The results can now be easily plotted (for the actual script used to obtain this plot plese refer to the documentation):
+The data is returned as a matrix, `output` in the code above, that contains the predicted trajectories. The results can now be easily plotted (for the actual script used to obtain this plot please refer to the documentation):
 ```julia
 using Plots
 plot(transpose(output),layout=(3,1), label="predicted")

docs/src/index.md

@@ -69,9 +69,6 @@ In addition, multiple ways of driving the reservoir states are also provided:
 - ```MRNN```: Multiple RNN driver, it consists of a linear combination of RNNs
 - ```GRU```: gated Recurrent Unit driver, with all the possible GRU variants available:
   - ```FullyGated```
-  - ```Variant1```
-  - ```Variant2```
-  - ```Variant3```
   - ```Minimal```
 
 A hybrid version of the model is also available through ```Hybrid```

src/ReservoirComputing.jl

@@ -18,11 +18,10 @@ export StandardRidge, LinearModel
 export AbstractLayer, create_layer
 export WeightedLayer, DenseLayer, SparseLayer, MinimumLayer, InformedLayer, NullLayer
 export BernoulliSample, IrrationalSample
-export GaussianProcess
 export AbstractReservoir, create_reservoir
 export RandSparseReservoir, PseudoSVDReservoir, DelayLineReservoir
 export DelayLineBackwardReservoir, SimpleCycleReservoir, CycleJumpsReservoir, NullReservoir
-export RNN, MRNN, GRU, GRUParams, FullyGated, Variant1, Variant2, Variant3, Minimal
+export RNN, MRNN, GRU, GRUParams, FullyGated, Minimal
 export ESN, Default, Hybrid, train
 export RECA, train
 export RandomMapping, RandomMaps

src/esn/esn_reservoir_drivers.jl

@@ -251,7 +251,7 @@ function reservoir_driver_params(gru::GRU, res_size, in_size)
     return gru_params
 end
 
-#dispatch on the differenct gru variations
+#dispatch on the different gru variations
 function create_gru_layers(gru, variant::FullyGated, res_size, in_size)
     Wz_in = create_layer(gru.inner_layer[1], res_size, in_size)
     Wz = create_reservoir(gru.reservoir[1], res_size)

src/esn/esn_reservoirs.jl

@@ -274,7 +274,7 @@ end
 Return a Cycle Reservoir with Jumps constructor to create a reservoir matrix as described
 in [1]. The ```weight``` and ```jump_weight``` can be passed as args or kwargs, and they
 determine the absolute values of all the connections in the reservoir. The ```jump_size```
-can also be passed either as arg or kwarg, and it detemines the jumps between
+can also be passed either as arg or kwarg, and it determines the jumps between
 ```jump_weight```s.
 
 [1] Rodan, Ali, and Peter Tiňo. "_Simple deterministically constructed cycle reservoirs

test/qa.jl

@@ -0,0 +1,11 @@
+using ReservoirComputing, Aqua
+@testset "Aqua" begin
+    Aqua.find_persistent_tasks_deps(ReservoirComputing)
+    Aqua.test_ambiguities(ReservoirComputing, recursive = false)
+    Aqua.test_deps_compat(ReservoirComputing)
+    Aqua.test_piracies(ReservoirComputing)
+    Aqua.test_project_extras(ReservoirComputing)
+    Aqua.test_stale_deps(ReservoirComputing)
+    Aqua.test_unbound_args(ReservoirComputing)
+    Aqua.test_undefined_exports(ReservoirComputing)
+end

test/runtests.jl

@@ -2,6 +2,7 @@ using SafeTestsets
 using Test
 
 @testset "Common Utilities   " begin
+    @safetestset "Quality Assurance" begin include("qa.jl") end
     @safetestset "States" begin include("test_states.jl") end
 end