feat: split reca models in Ext

.buildkite/documentation.yml

@@ -1,5 +1,5 @@
 steps:
-  - label: ":page_facing_up: Build and Deploy Documentation"
+  - label: ":page_facing_up: Build and Deploy ReservoirComputing Documentation"
     plugins:
       - JuliaCI/julia#v1:
           version: "1"
@@ -20,6 +20,21 @@ steps:
     if: build.message !~ /\[skip docs\]/ && !build.pull_request.draft
     timeout_in_minutes: 1000
 
+  - label: ":page_facing_up: Build & Deploy ReservoirCellularAutomata Documentation"
+    plugins:
+      - JuliaCI/julia#v1:
+          version: "1"
+    command: |
+      julia --project=lib/ReservoirCellularAutomata/docs -e '
+        using Pkg; Pkg.instantiate()
+        include("make.jl")
+      '
+    agents:
+      queue: "juliagpu"
+      cuda: "*"
+    if: build.message !~ /\[skip docs\]/ && !build.pull_request.draft
+    timeout_in_minutes: 1000
+
 env:
   JULIA_PKG_SERVER: "" # it often struggles with our large artifacts
   SECRET_DOCUMENTER_KEY: "qmrtZ2jy2W0e2h5zu3V7g+wxiz/1BHLsjKGHfosfjxel5nf6/s1mPA+4DEZcBUHwBFt7tfxoKOA6H1gk5PdbyJvFJA6xs4/PT8xvotzv9eYpxtJIoKLRQvjUCq78T+7/0DoicsMNk1uP3/JNkwm4TRLqVXs9QAe9HPnh6x+q/Sro0x9DXIUE2xbTQ3JP6ZUVhS04X7OCeuGTJbW8TdH8B+7V90+gJZcg5a7ctRP/V+PxDo++SOmdyryeqvwE+e6a8+czUWh9gaFQ4dXFRgoUAq+O/jRXSbQfWBXLGaubpMAodgZUmzVSOygELDdRVUhaENgfQfvnUpgpxX8UX/3Bcw==;U2FsdGVkX1+vDdZIUCqY5I21wuyok0l+8wfkXvIMQMIOQ2VwCtKCaXkZG3XHqFRY5GRWAY2PZ96gE8Y64/pcvNwe+9mbS9RRkJvT47p86lkyC88W6BD6/jp44ojsERcUJzWCMxCygm0JH/kTr74YYCxV0vebHOd0F693LQPATXZDBWYIb+pOgBSmHVGssBEixcKbaNzUPSv3RpIF9J8pmwTZjEkP3+8xlXjK8RBR3+irVGyEarWNapp0dQlsYYrGBGWmUATsIHsLQ66WzEo3srne6AYmKK4R5GQyhXWmUFXCW9kipObta+N+Re6sYnekn62JkGuUQpebUiDEXmHHo+z5dA1WUO6uHP6d+US2DXcK89jcCsFNU+XVjfTlIWv2TbnRlBv/v/1zEIv+a5j2i2lA9bTtryLqREBIldqFimdpVxDtEq/qhRk57Eg4qBiBMAsM87ZREynYCwCRmvQ+5DfViRKBmGr/odV/1Nzskih8MxsOXv2gztaFVlC10xtJVQ3G+MiIBUMEjF3xu9dbhQqGw4t1FbUR2d/CBrf3qgF7x5EN3QI0MHJXL+738iam917+nmWsM2O1w8eRZZi56jURj0cv/jWY7lLQwGJEn1l6erQOGCBmS+VD2O4hngh8/eaF1bmOgyKAKkPR6VWhJqoAeBrlPCmo0ydWo/o5WW5tXMt1D4w7VZbXaBg9GLYWrLkGT/n+tWr2VHBTzn/+9E3nIu8SJDrl97yZWtemAe6lhPC1J4AoxLW9yCC7BSse4BUHSqEIdnwlFRoO9/5gkr86CwtQ0ZqusospnCxPQoQiuC1Rv3RsiQ87Hz3Dw6x/dLJ16mZmMQh7sJMLjHk/P9nwdSI0j/agwCAeyjvuXmKua6vd/NPnK3kAZymGjb3Mo/iY8Av6qM7Fbn/ltg9Ys7uiVdgeUavWx9tCcB3nB7ZGC8TESCWWgpY04PPcaprOXA80EEarwcGoNch9i9lY5jdFoTgVp1ltErchTe5DFe+Cd0ryyjivpwmQy8FxPAQkHIRssPIsOiCwl9QONgsq4l3x2Qsgq82GwXWFS+Ok06wHNkotQKG+chmcU2r3qeqJj4ajMpnQnEy5j8SU2Vkw/yWV1cYQPt8EyIsOXqE8+GXYzOjOrYCkJ8VSYX4XMuAzVQ3KXxxEyKPw0VgbZKycommCvk7sfLSJ8QXKDmihW2NlV4iO2FJSbmmNX0M3JbaxCrTubfgdJeI68iPy75lBUBh8j980t1IeuF+ekL8wzsoDjsIBAvB0GinT5h8CKB5Jfoy5VC8f1TOZqq0ClJMvZq4AWO+8g1i5PhCc7mlLrgwrbcOQAaTMN3VPKay62JFjGcOuZs2bjN/Be+trbHS42cXlpnRUxHVcfx8WdTG41bJi5irNfYk2pQ6FEA1453k8KcqJNnZujfAKwYZQNnXBxHj6rj1K4lcEHNkOjrYvRV6luXtgKGwQbpVtL66pyYtuQc3yGM9bDMGQkxV1JCxKbYpjPjXE/bXULNdnlBF2KMgllqkq1KQ6s9X6KSVyq7e3TR9iHDoCqWBOFs0Zl7hvXcGKRZv9iWA1A4bgPQfbNWQ+Bvy4tyITg76itxnPo2qelOuOPL36+dY5N6Y8clF4BTLrEQXY0YHK5zDauhmiBSP67eSjajt+iHL18bkn1U9G5BKUEXtR3mmGf3KzDwnVnpaVtllV3fkWO0bSVcsFeE7XQijvSVW5f2UBg5ywfD0+WbPdJbs+g5cd2cxLItHSAgx/9rApCeoflu3gpW4tMVxkuwyxrviowZIwpUoNjXRH48HX1iEvPCtPlLBZ6D+WNUQhqgFtmmtGXsv/XhibLjhlnUsAukKiHZjLKWsjJnkDVn3yXe5s6y3dh47GRcnnJyLht3vMkilLLcbkgrotCBGdHk+bm1M1/IaOdyI4sdO/hOe7+VnDTVKt4HJNN+djKGX/+X8WbtNEyh/G4iWHp9JcHGWJXQbbhnGdRA1T6KtAbJoBjf7ESwemrnac3gejHmbjeYGDtBamExgkja8vNmt66tYAj/qOmC2jYtqlZrzlr3vSvyRpM8f74SWkvw544nUpBV7I4xQcO2RgUgMnXCKmMf8VioYZd7o4Qc9pm36FM/m7xpj9yl0GwwxY9TUoX5ruL5rXxet9+IUcx2D461vrSvf1kqVfW2UIb8nvGMfnt3yswV9uQONVW91lqLq2u8asFDusG070Q+l9M0l7f4Da23/i2zjGZ57vBh3FOKClW+mCWVPeaQJ860CAl1QhyFsbv5O7U3Rp05AglTCQsmgzIDCJPUuiCcKJkcqfGWKniEUvIzFBD/aNkBO4FSlmPi8MzpHYJfZi5PG7G31RV+gSjVnLwX6ZYLVhtOBSH9TiGQC5R0M1X2qAOiHtBbp2aOWW9nWvPdXK76nKCXI+/FFWeKzBMWxwNvfyW1Nxc/K0HLuVX6ltnxx34LjJ9bxHeSRDZJaJsFSAaSjnbAdVcQXs7J8ewYXcOVLZXVQnZ4CycDikno4rItVOjZpIYQOW4McoLclO0QMAOWzaJ+iRGNLNMkLRedsTJ5ziFbLnKoJxM6AxlKDyLyvaqEM9r35pczh2/BQbr79bJ4Q8Fb8BKWPjOtTQ/NhHdhT78qAVPpmcDANIEfU1oEQf/rKUkI8QpUKBl3jetFtSz6MD0ROkNVWoA5d00mtetfjl+BOxyVcog8fw+Dc7zb7rF3TLwNM9QlkoNJ3VLckwZjbWoe2FPdn5f8Fz1oOWhEZH6xefT3A0uYJqPKGNG+CrAZv5vVvr9cSiTgipEPvWCZYkWK6FMdHwbGEt0em0/DEp1KUWze/aNtcbmSQhEofB2TMYEnl1KdOyhm4pnPtN5tjjTkZoIhjELgAi9gyIuDqqzQ3IWdLE8KdmbdT++OE1cBgNkJPVf33UhPqnAR8L38XsnaG939YNVze0eMGX/AuXjsrjV88E0MrfE60FIiRTAfZ1QP78oix4m/CY70MjWpGZDUuxyDro2vJJt/vhRjNT9NyPhFWIMpfQf6aPyeF1BWrd2z8kcMMXp5aWMHRhlvrzDXTAcWqqkVhprL2ii+UKCxT3GYF1zgaZ4FO/Oa2Fz90WFb0ckfvOyUM9vZ2YLAuWTPGoon4hnuVlXPtslGdoQ+zxyi+wJeg8K00CZkQvdKSNzc88uJC+MIGRowaa0oq/LPoev6IVj7iZIWRu/Ufvt8X5cwBD65yA48Z7dclbHErZfSAu5NjuS2VCPnOUSfMlrxxosUN16qpLd0+hC7WP1Nw6HBJcvXGhxq9vMWJYUFKMY0bXrjHSt4AFO0SFJewIgY5CPdLrFy10s8eclUSHOvxC4rdtUimZgy/+DsPEiCgOWmo97R1Zp86rG6oPelCnK8MWVOSqWqigW/f3h2KZ3rqNGxYz5t9gxaKf7BRCGTmzxmZAe1IvpAqQA8efaLlba+T9+XInRK9QujL+OWlDiDm85xOhZZ/eE/TgkkXNuMbPcXxv1Y41Yo7r1YS4qKJnuiTPJcla7RC0BmLxmnsv8cPKCZhakhDVjP10OFjIDeLcHIaeNOwxlK6YyP176nqc7j4S1b5ym6L46hRsm1RoTqsewcd1g9ykeWIEbMz53A1TjRcWyM0F2eZ9sxGsWDY/POsOvmlz2g2D0GTx8OCz5iegcEf9aa/1dCiFYy35kpayzNfnGwTB1q6zu70/xQ6demgMnGx4BPcGubfQC6UyrwXXWiVx8H4nUvKt+7EHTjv1g3UhK9S+xr7zI5YdgyrLIuDR1O/y93p+pEpmHJdhmG76exKgktc4CkYq/a2+Nvo+yCYrCvzMw4xQAs0eK3HM3NMUSfExOn7m6aOcPITvuaJSqJmeAFJuMV2p9f8QkUvcXMQjH51irQAY1xNPSvf0FssRHnpRZ6ywDkQ7BtSj3KpeWBCe9P1lLZ72M4A9ka54kr3YKWjHnHWY7rY/NMFDj5Du8thpHUr/cMRr9lnDK7GQbrNCUXHzyKObtvRDuF7vaepMTgDk1rOyVOVfMnJqBMh3ywGJZz8ote3K1gsqplfkXPWU9xGkxb1zM1qDkobzJsq2oo2nPcHW0QgVZ3B77SmS9atwa0zKkPkET+NU9VXn6QVwEO4/D6tqgelOK6fYmQKgz3Hccrpp54REE5FSRXGuD3AQczEETPj51FmJC5way9xedsyaVOTrW3Vm1Xh/ZsDzkRzOABDUZksVs1BTA1/7Lfb4vgMwdka0Ohb5gGcsqRTyJVTSFcjaux0Xi0S5URQIAxhFxQ13zNJZv8t6oK3UEmDGeseVz4oMqYEFBr2831QMLqadubFNBHPdKx10jmus+f26NirJv+CXYFFB2cC4qn8iI3XmmBKL1kK9BOQZiOs55sHOI6i16k2Noev0ushuQVrmrXXoPQusHblqa38KvM8QOEErHcXikQafuLPP5elF"

.github/workflows/CompatHelper.yml

@@ -10,7 +10,9 @@ jobs:
     steps:
       - name: Pkg.add("CompatHelper")
         run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
+
       - name: CompatHelper.main()
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: julia -e 'using CompatHelper; CompatHelper.main(;subdirs=["", "docs"])'
+        run: julia -e 'using CompatHelper; CompatHelper.main(;subdirs=["", "docs", "lib/ReservoirCellularAutomata", "lib/ReservoirCellularAutomata/docs"])'
+

.github/workflows/Downgrade.yml

@@ -1,36 +1,51 @@
 name: Downgrade
+
 on:
   pull_request:
-    branches:
-      - master
-    paths-ignore:
-      - 'docs/**'
+    branches: [ master ]
+    paths-ignore: [ 'docs/**' ]
   push:
-    branches:
-      - master
-    paths-ignore:
-      - 'docs/**'
+    branches: [ master ]
+    paths-ignore: [ 'docs/**' ]
+
 jobs:
   test:
     runs-on: ubuntu-latest
+
     strategy:
+      fail-fast: false
       matrix:
-        group:
-          - Core
+        project:
+          - name: ReservoirComputing
+            path: .
+          - name: ReservoirCellularAutomata
+            path: lib/ReservoirCellularAutomata
+        group:      ['Core']
         downgrade_mode: ['alldeps']
         julia-version: ['1.10']
+
+    name: Downgrade – ${{ matrix.project.name }} · Julia ${{ matrix.julia-version }}
+
     steps:
       - uses: actions/checkout@v4
+
       - uses: julia-actions/setup-julia@v2
         with:
-          version: ${{ matrix.julia-version }}
+          julia-version: ${{ matrix.julia-version }}
+
       - uses: julia-actions/julia-downgrade-compat@v2
-#        if: ${{ matrix.version == '1.6' }}
         with:
-          skip: Pkg,TOML
+          skip:  Pkg,TOML
+          mode:  ${{ matrix.downgrade_mode }}
+          project: ${{ matrix.project.path }}
+
       - uses: julia-actions/julia-buildpkg@v1
+        with:
+          project: ${{ matrix.project.path }}
+
       - uses: julia-actions/julia-runtest@v1
         with:
-          ALLOW_RERESOLVE: false
+          project:        ${{ matrix.project.path }}
+          allow-reresolve: false
         env:
-          GROUP: ${{ matrix.group }}
+          GROUP: ${{ matrix.group }}

.github/workflows/TagBot.yml

@@ -1,3 +1,5 @@
+# Inspiration from https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/blob/master/.github/workflows/TagBot.yml
+# and https://github.com/LuxDL/Lux.jl/blob/main/.github/workflows/TagBot.yml
 name: TagBot
 on:
   issue_comment:
@@ -21,13 +23,22 @@ permissions:
   security-events: read
   statuses: read
 jobs:
-  TagBot:
+  TagBot-ReservoirComputing:
     if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
     runs-on: ubuntu-latest
     steps:
-      - uses: JuliaRegistries/TagBot@62dd7cd21dcde087eca10e70c3fc3f8cefbe44a2
+      - name: Tag ReservoirComputing
+        uses: JuliaRegistries/TagBot@62dd7cd21dcde087eca10e70c3fc3f8cefbe44a2
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          # Edit the following line to reflect the actual name of the GitHub Secret containing your private key
           ssh: ${{ secrets.DOCUMENTER_KEY }}
-          # ssh: ${{ secrets.NAME_OF_MY_SSH_PRIVATE_KEY_SECRET }}
+  TagBot-ReservoirCellularAutomata:
+    if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Tag ReservoirCellularAutomata
+        uses: JuliaRegistries/TagBot@62dd7cd21dcde087eca10e70c3fc3f8cefbe44a2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          ssh: ${{ secrets.DOCUMENTER_KEY }}
+          subdir: "lib/ReservoirCellularAutomata"

.github/workflows/TestsReservoirCellularAutomata.yml

@@ -0,0 +1,40 @@
+name: "Tests - ReservoirCellularAutomata"
+
+on:
+  pull_request:
+    branches:
+      - master
+    paths:
+      - "lib/ReservoirCellularAutomata/**"
+      - ".github/workflows/TestsReservoirCellularAutomata.yml"
+  push:
+    branches:
+      - master
+    paths-ignore:
+      - 'docs/**'
+  schedule:
+    - cron: '33 1 * * 4'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref_name != github.event.repository.default_branch || github.ref != 'refs/tags/v*' }}
+
+jobs:
+  tests:
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - "1"
+          - "lts"
+          - "pre"
+        os:
+          - "ubuntu-latest"
+          - "macos-latest"
+          - "windows-latest"
+    uses: "SciML/.github/.github/workflows/tests.yml@v1"
+    with:
+      julia-version: "${{ matrix.version }}"
+      os: "${{ matrix.os }}"
+      project: "lib/ReservoirCellularAutomata"
+    secrets: "inherit"

.github/workflows/Tests.yml → .github/workflows/TestsReservoirComputing.yml

@@ -1,4 +1,4 @@
-name: "Tests"
+name: "Tests - ReservoirComputing"
 
 on:
   pull_request:

Project.toml

@@ -1,11 +1,10 @@
 name = "ReservoirComputing"
 uuid = "7c2d2b1e-3dd4-11ea-355a-8f6a8116e294"
 authors = ["Francesco Martinuzzi"]
-version = "0.11.3"
+version = "0.12.0"
 
 [deps]
 Adapt = "79e6a3ab-5dfb-504d-930d-738a2a938a0e"
-CellularAutomata = "878138dc-5b27-11ea-1a71-cb95d38d6b29"
 Compat = "34da2185-b29b-5c13-b0c7-acf172513d20"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 NNlib = "872c559c-99b0-510c-b3b7-b6c96a88d5cd"
@@ -14,19 +13,21 @@ Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
 WeightInitializers = "d49dbf32-c5c2-4618-8acc-27bb2598ef2d"
 
 [weakdeps]
+CellularAutomata = "878138dc-5b27-11ea-1a71-cb95d38d6b29"
 LIBSVM = "b1bec4e5-fd48-53fe-b0cb-9723c09d164b"
 MLJLinearModels = "6ee0df7b-362f-4a72-a706-9e79364fb692"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 
 [extensions]
+RCCellularAutomataExt = "CellularAutomata"
 RCLIBSVMExt = "LIBSVM"
 RCMLJLinearModelsExt = "MLJLinearModels"
 RCSparseArraysExt = "SparseArrays"
 
 [compat]
 Adapt = "4.1.1"
 Aqua = "0.8"
-CellularAutomata = "0.0.2"
+CellularAutomata = "0.0.6"
 Compat = "4.16.0"
 DifferentialEquations = "7.16.1"
 LIBSVM = "0.8"

docs/make.jl

@@ -15,6 +15,7 @@ bib = CitationBibliography(
 
 makedocs(; modules = [ReservoirComputing],
     sitename = "ReservoirComputing.jl",
+    authors = "Francesco Martinuzzi",
     clean = true, doctest = false, linkcheck = true,
     plugins = [bib],
     format = Documenter.HTML(;

docs/pages.jl

@@ -12,13 +12,11 @@ pages = [
         #"Using Different Training Methods" => "esn_tutorials/different_training.md",
         "Deep Echo State Networks" => "esn_tutorials/deep_esn.md",
         "Hybrid Echo State Networks" => "esn_tutorials/hybrid.md"],
-    "Reservoir Computing with Cellular Automata" => "reca_tutorials/reca.md",
     "API Documentation" => Any["Training Algorithms" => "api/training.md",
         "States Modifications" => "api/states.md",
         "Prediction Types" => "api/predict.md",
         "Echo State Networks" => "api/esn.md",
         "ESN Initializers" => "api/inits.md",
         "ESN Drivers" => "api/esn_drivers.md",
-        "ESN Variations" => "api/esn_variations.md",
-        "ReCA" => "api/reca.md"]    #"References" => "references.md"
+        "ESN Variations" => "api/esn_variations.md"]
 ]