v0.2.3 (#142)

* v0.2.3

Signed-off-by: FL03 <jo3mccain@icloud.com>

* update

Signed-off-by: FL03 <jo3mccain@icloud.com>

* update .github/workflows

Signed-off-by: FL03 <jo3mccain@icloud.com>

* update cargo-clippy.yml

Signed-off-by: FL03 <jo3mccain@icloud.com>

* update

Signed-off-by: FL03 <jo3mccain@icloud.com>

* update

Signed-off-by: FL03 <jo3mccain@icloud.com>

* update

Signed-off-by: FL03 <jo3mccain@icloud.com>

* update

Signed-off-by: FL03 <jo3mccain@icloud.com>

* update

Signed-off-by: FL03 <jo3mccain@icloud.com>

* update

Signed-off-by: FL03 <jo3mccain@icloud.com>

* update

Signed-off-by: FL03 <jo3mccain@icloud.com>

---------

Signed-off-by: FL03 <jo3mccain@icloud.com>

Author: FL03

.artifacts/.gitkeep

@@ -1,4 +1,4 @@
-name: Benchmark (rust)
+name: Benchmark
 
 concurrency:
   cancel-in-progress: false

.artifacts/assets/logo.svg

@@ -28,7 +28,6 @@ on:
 
 jobs:
   clippy:
-    continue-on-error: true
     runs-on: ubuntu-latest
     permissions:
       actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
@@ -60,6 +59,7 @@ jobs:
       -
         name: Upload analysis
         uses: github/codeql-action/upload-sarif@v3
+        continue-on-error: true
         with:
           sarif_file: rust-clippy-results.sarif
           wait-for-processing: true

.github/workflows/cargo-bench.yml

@@ -1,12 +1,12 @@
-name: crates-io
+name: Publish
 
 concurrency:
   cancel-in-progress: false
   group: ${{ github.workflow }}-${{ github.ref }}
 
 on:
   repository_dispatch:
-    types: [ cargo-publish, crates-io ]
+    types: [ deploy, publish, cargo-publish, crates-io ]
   workflow_dispatch:
     inputs:
       publish:
@@ -42,11 +42,12 @@ jobs:
           - concision-derive
           - concision-macros
           - concision
+          - concision-ext
           # non-sdk packages
           - concision-kan
           - concision-s4
           - concision-transformer
-          - concision-ext
+          - concision-models
     steps:
       -
         name: Checkout

.github/workflows/clippy.yml .github/workflows/cargo-clippy.yml.github/workflows/clippy.yml renamed to .github/workflows/cargo-clippy.yml

@@ -36,23 +36,24 @@ license = "Apache-2.0"
 readme = "README.md"
 repository = "https://github.com/FL03/concision.git"
 rust-version = "1.85.0"
-version = "0.2.2"
+version = "0.2.3"
 
 [workspace.dependencies]
-# sdk
-concision = { default-features = false, path = "concision", version = "0.2.2" }
-concision-core = { default-features = false, path = "core", version = "0.2.2" }
-concision-data = { default-features = false, path = "data", version = "0.2.2" }
-concision-derive = { default-features = false, path = "derive", version = "0.2.2" }
-concision-init = { default-features = false, path = "init", version = "0.2.2" }
-concision-macros = { default-features = false, path = "macros", version = "0.2.2" }
-concision-neural = { default-features = false, path = "neural", version = "0.2.2" }
-concision-utils = { default-features = false, path = "utils", version = "0.2.2" }
-# extra crates
-concision-ext = { default-features = false, path = "ext", version = "0.2.2" }
-concision-kan = { default-features = false, path = "models/kan", version = "0.2.2" }
-concision-s4 = { default-features = false, path = "models/s4", version = "0.2.2" }
-concision-transformer = { default-features = false, path = "models/transformer", version = "0.2.2" }
+concision = { default-features = false, path = "concision", version = "0.2.3" }
+concision-core = { default-features = false, path = "core", version = "0.2.3" }
+concision-data = { default-features = false, path = "data", version = "0.2.3" }
+concision-derive = { default-features = false, path = "derive", version = "0.2.3" }
+concision-init = { default-features = false, path = "init", version = "0.2.3" }
+concision-macros = { default-features = false, path = "macros", version = "0.2.3" }
+concision-neural = { default-features = false, path = "neural", version = "0.2.3" }
+concision-utils = { default-features = false, path = "utils", version = "0.2.3" }
+# extras
+concision-ext = { default-features = false, path = "ext", version = "0.2.3" }
+# models
+concision-models = { default-features = false, path = "macros", version = "0.2.3" }
+concision-kan = { default-features = false, path = "models/kan", version = "0.2.3" }
+concision-s4 = { default-features = false, path = "models/s4", version = "0.2.3" }
+concision-transformer = { default-features = false, path = "models/transformer", version = "0.2.3" }
 
 # custom
 scsys = { default-features = false, features = ["derive"], version = "0.3.1" }

.github/workflows/cargo-publish.yml

@@ -13,6 +13,29 @@ _**Warning: The library still in development and is not yet ready for production
 - `autodiff`: the upcoming feature enabling rust to natively support automatic differentiation.
 - [`ndarray`](https://docs.rs/ndarray): The crate is designed around the `ndarray` crate, which provides a powerful N-dimensional array type for Rust
 
+## Overview
+
+### Goals
+
+- Provide a flexible and extensible framework for building neural network models in Rust.
+- Support both shallow and deep neural networks with a focus on modularity and reusability.
+- Enable easy integration with other libraries and frameworks in the Rust ecosystem.
+
+### Roadmap
+
+- [ ] **v1**:
+  - [ ] **`ParamsBase`**: Design a basic structure for storing model parameters.
+  - [ ]  **Traits**: Create a set of traits for defining the basics of a neural network model.
+    - `Forward` and `Backward`: traits defining forward and backward propagation
+    - `Model`: A trait for defining a neural network model.
+    - `Predict`: A trait extending the basic [`Forward`](cnc::Forward) pass.
+    - `Train`: A trait for training a neural network model.
+- [ ] **v2**:
+  - [ ] **Models**:
+    - `Trainer`: A generic model trainer that can be used to train any model.
+  - [ ] **Layers**: Implement a standard model configuration and parameters.
+    - `LayerBase`: _functional_ wrappers for the `ParamsBase` structure.
+
 ## Usage
 
 ### Adding to your project