Structure basic learning documentation

docs/Manifest.toml

@@ -1,6 +1,6 @@
 # This file is machine-generated - editing it directly is not advised
 
-julia_version = "1.10.2"
+julia_version = "1.10.0"
 manifest_format = "2.0"
 project_hash = "1b9658bdf261a7c6654c76e78c2b14b059e43c02"
 
@@ -185,13 +185,11 @@ weakdeps = ["Dates", "LinearAlgebra"]
 [[deps.CompilerSupportLibraries_jll]]
 deps = ["Artifacts", "Libdl"]
 uuid = "e66e0078-7015-5450-92f7-15fbd957f2ae"
-version = "1.1.0+0"
+version = "1.0.5+1"
 
 [[deps.CompositionalNetworks]]
 deps = ["ConstraintCommons", "ConstraintDomains", "Dictionaries", "Distances", "JuliaFormatter", "OrderedCollections", "Random", "TestItemRunner", "TestItems", "ThreadSafeDicts", "Unrolled"]
-git-tree-sha1 = "fa90dcc50a4733e873ecb7959d9518fb7d1d9d66"
-repo-rev = "doc"
-repo-url = "https://github.com/JuliaConstraints/CompositionalNetworks.jl.git"
+path = "/root/.julia/dev/CompositionalNetworks"
 uuid = "4b67e4b5-442d-4ef5-b760-3f5df3a57537"
 version = "0.5.5"
 
@@ -855,7 +853,7 @@ version = "0.2.5"
 [[deps.OpenBLAS_jll]]
 deps = ["Artifacts", "CompilerSupportLibraries_jll", "Libdl"]
 uuid = "4536629a-c528-5b80-bd46-f80d51c5b363"
-version = "0.3.23+4"
+version = "0.3.23+2"
 
 [[deps.OpenLibm_jll]]
 deps = ["Artifacts", "Libdl"]

docs/src/learning/aggregation.md

@@ -0,0 +1,21 @@
+# Aggregation Layer
+
+```@meta
+CurrentModule = CompositionalNetworks
+```
+
+Some text to describe the aggragation layer within usual ICNs.
+
+## List of aggregations
+
+```@docs; canonical=false
+ag_sum
+ag_count_positive
+```
+
+
+## Layer generation
+
+```@docs; canonical=false
+aggregation_layer
+```

docs/src/learning/arithmetic.md

@@ -0,0 +1,21 @@
+# Arithmetic Layer
+
+```@meta
+CurrentModule = CompositionalNetworks
+```
+
+Some text to describe the arithmetic layer within usual ICNs.
+
+## List of arithmetic operations
+
+```@docs; canonical=false
+ar_sum
+ar_prod
+```
+
+
+## Layer generation
+
+```@docs; canonical=false
+arithmetic_layer
+```

docs/src/learning/comparison.md

@@ -0,0 +1,38 @@
+# Comparison Layer
+
+```@meta
+CurrentModule = CompositionalNetworks
+```
+
+Some text to describe the comparison layer within usual ICNs.
+
+## List of comparisons
+
+List the possible parameters and how it affects the comparison.
+
+### Non-parametric
+
+```@docs; canonical=false
+co_identity
+co_euclidian
+co_abs_diff_val_vars
+co_val_minus_vars
+co_vars_minus_val
+```
+
+### Param: `:val`
+
+```@docs; canonical=false
+co_abs_diff_val_param
+co_val_minus_param
+co_param_minus_val
+co_euclidian_param
+```
+
+
+### Layer generation
+
+```@docs; canonical=false
+make_comparisons
+comparison_layer
+```

docs/src/learning/transformation.md

@@ -0,0 +1,48 @@
+# Transformations Layer
+
+```@meta
+CurrentModule = CompositionalNetworks
+```
+
+Some text to describe the transformation layer within usual ICNs.
+
+The implementation of the transformation relies heavily on the use of the lazy function (make a ref, open an issue to make `@lazy` macro in front of each transformation).
+
+## List of transformations
+
+List the possible parameters and how it affects the transformations.
+
+### Non-parametric
+
+```@docs; canonical=false
+tr_identity
+tr_count_eq
+tr_count_right
+tr_count_eq_left
+tr_count_greater
+tr_count_lesser
+tr_count_g_left
+tr_count_g_right
+tr_count_l_right
+tr_contiguous_vals_minus
+tr_contiguous_vals_minus_rev
+```
+
+### Param: `:val`
+
+```@docs; canonical=false
+tr_count_eq_param
+tr_count_l_param
+tr_count_g_param
+tr_count_bounding_param
+tr_val_minus_param
+tr_param_minus_val
+```
+
+
+### Layer generation
+
+```@docs; canonical=false
+make_transformations
+transformation_layer
+```