Merge pull request #7 from kamalsaleh/master

change names of some attributes and include two examples in the readme file

Author: kamalsaleh

PackageInfo.g

@@ -10,7 +10,7 @@ SetPackageInfo( rec(
 
 PackageName := "MachineLearningForCAP",
 Subtitle := "Exploring categorical machine learning in CAP",
-Version := "2024.07-17",
+Version := "2024.07-20",
 Date := (function ( ) if IsBound( GAPInfo.SystemEnvironment.GAP_PKG_RELEASE_DATE ) then return GAPInfo.SystemEnvironment.GAP_PKG_RELEASE_DATE; else return Concatenation( ~.Version{[ 1 .. 4 ]}, "-", ~.Version{[ 6, 7 ]}, "-01" ); fi; end)( ),
 License := "GPL-2.0-or-later",
 

README.md

@@ -26,22 +26,22 @@ f := Smooth.Softmax( 3 );
 f := MorphismConstructor( Para, R1 / Para, [ R2, f ], R3 / Para );
 #! ℝ^1 -> ℝ^3 defined by:
 #!
-#! Parameter Object:
+#! Underlying Object:
 #! -----------------
 #! ℝ^2
 #!
-#! Parametrised Morphism:
-#! ----------------------
+#! Underlying Morphism:
+#! -------------------
 #! ℝ^3 -> ℝ^3
 Display( f );
 #! ℝ^1 -> ℝ^3 defined by:
 #!
-#! Parameter Object:
+#! Underlying Object:
 #! -----------------
 #! ℝ^2
 #!
-#! Parametrised Morphism:
-#! ----------------------
+#! Underlying Morphism:
+#! -------------------
 #! ℝ^3 -> ℝ^3
 #!
 #! ‣ Exp( x1 ) / (Exp( x1 ) + Exp( x2 ) + Exp( x3 ))
@@ -59,22 +59,22 @@ Display( r );
 g := ReparametriseMorphism( f, r );
 #! ℝ^1 -> ℝ^3 defined by:
 #!
-#! Parameter Object:
+#! Underlying Object:
 #! -----------------
 #! ℝ^2
 #!
-#! Parametrised Morphism:
-#! ----------------------
+#! Underlying Morphism:
+#! -------------------
 #! ℝ^3 -> ℝ^3
 Display( g );
 #! ℝ^1 -> ℝ^3 defined by:
 #!
-#! Parameter Object:
+#! Underlying Object:
 #! -----------------
 #! ℝ^2
 #!
-#! Parametrised Morphism:
-#! ----------------------
+#! Underlying Morphism:
+#! -------------------
 #! ℝ^3 -> ℝ^3
 #!
 #! ‣ Exp( Sqrt( x1 ) ) / (Exp( Sqrt( x1 ) ) + Exp( Cos( x2 ) ) + Exp( x3 ))
@@ -83,32 +83,32 @@ Display( g );
 l := Para.AffineTransformation( 3, 2 );
 #! ℝ^3 -> ℝ^2 defined by:
 #!
-#! Parameter Object:
+#! Underlying Object:
 #! -----------------
 #! ℝ^8
 #!
-#! Parametrised Morphism:
-#! ----------------------
+#! Underlying Morphism:
+#! -------------------
 #! ℝ^11 -> ℝ^2
 h := PreCompose( g, l );
 #! ℝ^1 -> ℝ^2 defined by:
 #!
-#! Parameter Object:
+#! Underlying Object:
 #! -----------------
 #! ℝ^10
 #!
-#! Parametrised Morphism:
-#! ----------------------
+#! Underlying Morphism:
+#! -------------------
 #! ℝ^11 -> ℝ^2
 Display( h );
 #! ℝ^1 -> ℝ^2 defined by:
 #!
-#! Parameter Object:
+#! Underlying Object:
 #! -----------------
 #! ℝ^10
 #!
-#! Parametrised Morphism:
-#! ----------------------
+#! Underlying Morphism:
+#! -------------------
 #! ℝ^11 -> ℝ^2
 #!
 #! ‣ x1 * (Exp( Sqrt( x9 ) ) / (Exp( Sqrt( x9 ) ) + Exp( Cos( x10 ) ) + Exp( x11 )))
@@ -123,22 +123,22 @@ r := Smooth.Constant( constants );
 t := ReparametriseMorphism( h, r );
 #! ℝ^1 -> ℝ^2 defined by:
 #!
-#! Parameter Object:
+#! Underlying Object:
 #! -----------------
 #! ℝ^0
 #!
-#! Parametrised Morphism:
-#! ----------------------
+#! Underlying Morphism:
+#! -------------------
 #! ℝ^1 -> ℝ^2
 Display( t );
 #! ℝ^1 -> ℝ^2 defined by:
 #!
-#! Parameter Object:
+#! Underlying Object:
 #! -----------------
 #! ℝ^0
 #!
-#! Parametrised Morphism:
-#! ----------------------
+#! Underlying Morphism:
+#! -------------------
 #! ℝ^1 -> ℝ^2
 #!
 #! ‣ 0.91 * (2.39116 / (5.10727 + Exp( x1 ))) + 0.24 * (2.71611 / (5.10727 + Exp( x1 )))
@@ -148,22 +148,22 @@ Display( t );
 s := SimplifyMorphism( t, infinity );
 #! ℝ^1 -> ℝ^2 defined by:
 #!
-#! Parameter Object:
+#! Underlying Object:
 #! -----------------
 #! ℝ^0
 #!
-#! Parametrised Morphism:
-#! ----------------------
+#! Underlying Morphism:
+#! -------------------
 #! ℝ^1 -> ℝ^2
 Display( s );
 #! ℝ^1 -> ℝ^2 defined by:
 #!
-#! Parameter Object:
+#! Underlying Object:
 #! -----------------
 #! ℝ^0
 #!
-#! Parametrised Morphism:
-#! ----------------------
+#! Underlying Morphism:
+#! -------------------
 #! ℝ^1 -> ℝ^2
 #!
 #! ‣ (1.47 * Exp( x1 ) + 5.84111) / (Exp( x1 ) + 5.10727)
@@ -175,22 +175,22 @@ ApplyFunctor( iota, Smooth.( 1 ) );
 psi := ApplyFunctor( iota, Smooth.Sum( 2 ) );
 #! ℝ^2 -> ℝ^1 defined by:
 #!
-#! Parameter Object:
+#! Underlying Object:
 #! -----------------
 #! ℝ^0
 #!
-#! Parametrised Morphism:
-#! ----------------------
+#! Underlying Morphism:
+#! -------------------
 #! ℝ^2 -> ℝ^1
 Print( DisplayString( psi ) );
 #! ℝ^2 -> ℝ^1 defined by:
 #!
-#! Parameter Object:
+#! Underlying Object:
 #! -----------------
 #! ℝ^0
 #!
-#! Parametrised Morphism:
-#! ----------------------
+#! Underlying Morphism:
+#! -------------------
 #! ℝ^2 -> ℝ^1
 #!
 #! ‣ x1 + x2

examples/CategoryOfParametrisedMorphisms.g

@@ -546,9 +546,9 @@ InstallMethod( ViewString,
         " -> ",
         ViewString( Target( f ) ),
         " defined by:",
-        "\n\nParameter Object:\n-----------------\n",
+        "\n\nUnderlying Object:\n-----------------\n",
         ViewString( UnderlyingObject( f ) ),
-        "\n\nParametrised Morphism:\n----------------------\n",
+        "\n\nUnderlying Morphism:\n-------------------\n",
         ViewString( UnderlyingMorphism( f ) ) );
 
 end );
@@ -565,9 +565,9 @@ InstallMethod( DisplayString,
         " -> ",
         ViewString( Target( f ) ),
         " defined by:",
-        "\n\nParameter Object:\n-----------------\n",
+        "\n\nUnderlying Object:\n-----------------\n",
         ViewString( UnderlyingObject( f ) ),
-        "\n\nParametrised Morphism:\n----------------------\n",
+        "\n\nUnderlying Morphism:\n-------------------\n",
         DisplayString( UnderlyingMorphism( f ) ) );
 
 end );
@@ -584,9 +584,9 @@ InstallMethod( Display,
         " -> ",
         ViewString( Target( f ) ),
         " defined by:",
-        "\n\nParameter Object:\n-----------------\n",
+        "\n\nUnderlying Object:\n-----------------\n",
         ViewString( UnderlyingObject( f ) ),
-        "\n\nParametrised Morphism:\n----------------------\n" ) );
+        "\n\nUnderlying Morphism:\n-------------------\n" ) );
 
     Display( UnderlyingMorphism( f ) );