improve specs

Author: jalvesz

doc/specs/stdlib_specialfunctions_activations.md

@@ -1,5 +1,5 @@
 ---
-title: specialfunctions
+title: specialfunctions_activations
 ---
 
 # Special functions - Neural Networks activations and their gradients
@@ -337,7 +337,7 @@ scale * (\alpha * exp(x) - \alpha ), & \text{otherwise}
 \end{cases}
 $$
 Where,
-$$scale = 1.0507009873554804934193349852946 \text{and} \alpha = 1.6732632423543772848170429916717$$
+$scale = 1.0507009873554804934193349852946$ and $\alpha = 1.6732632423543772848170429916717$
 
 ### Syntax
 
@@ -406,7 +406,7 @@ $$f(x) = \frac{1}{1+\exp(-x)} $$
 
 ### Syntax
 
-`result = ` [[stdlib_specialfunctions(module):Sigmoid(interface)]] ` (x)`
+`result = ` [[stdlib_specialfunctions(module):sigmoid(interface)]] ` (x)`
 
 ### Class
 
@@ -433,7 +433,7 @@ $$f(x) = \frac{\exp(x)}{(1+\exp(x))^2} $$
 
 ### Syntax
 
-`result = ` [[stdlib_specialfunctions(module):Sigmoid_grad(interface)]] ` (x)`
+`result = ` [[stdlib_specialfunctions(module):sigmoid_grad(interface)]] ` (x)`
 
 ### Class
 
@@ -525,7 +525,7 @@ $$
 
 ### Syntax
 
-`result = ` [[stdlib_specialfunctions(module):Step(interface)]] ` (x)`
+`result = ` [[stdlib_specialfunctions(module):step(interface)]] ` (x)`
 
 ### Class
 
@@ -539,6 +539,11 @@ Elemental function
 
 The function returns a value with the same type and kind as input argument.
 
+### Example
+```fortran
+{!example/specialfunctions_activations/example_step.f90!}
+```
+
 ## `Step_grad` - Gradient of the Step function
 
 ### Status
@@ -552,7 +557,7 @@ $$f(x) = 0 $$
 
 ### Syntax
 
-`result = ` [[stdlib_specialfunctions(module):Step_grad(interface)]] ` (x)`
+`result = ` [[stdlib_specialfunctions(module):step_grad(interface)]] ` (x)`
 
 ### Class
 
@@ -579,7 +584,7 @@ $$f(x) = \frac{\exp(x)-\text{max}(x_j)}{\sum_j{\exp(x)-\text{max}(x_j)}}$$
 
 ### Syntax
 
-`result = ` [[stdlib_specialfunctions(module):Softmax(interface)]] ` (x,dim)`
+`result = ` [[stdlib_specialfunctions(module):softmax(interface)]] ` (x,dim)`
 
 ### Class
 
@@ -594,6 +599,11 @@ Pure function for ranks 1 to 4.
 
 The function returns an array with the same rank and kind as the input argument `x`.
 
+### Example
+```fortran
+{!example/specialfunctions_activations/example_softmax.f90!}
+```
+
 ## `Softmax_grad` - Gradient of the Softmax function
 
 ### Status
@@ -607,7 +617,7 @@ $$f(x,dim) = \text{Softmax}(x,dim)*(1-\text{Softmax}(x,dim)) $$
 
 ### Syntax
 
-`result = ` [[stdlib_specialfunctions(module):Softmax_grad(interface)]] ` (x,dim)`
+`result = ` [[stdlib_specialfunctions(module):softmax_grad(interface)]] ` (x,dim)`
 
 ### Class
 
@@ -635,7 +645,7 @@ $$f(x) = \log(\exp(x)+1)$$
 
 ### Syntax
 
-`result = ` [[stdlib_specialfunctions(module):Softplus(interface)]] ` (x)`
+`result = ` [[stdlib_specialfunctions(module):softplus(interface)]] ` (x)`
 
 ### Class
 
@@ -649,6 +659,11 @@ Elemental function
 
 The function returns a value with the same type and kind as input argument.
 
+### Example
+```fortran
+{!example/specialfunctions_activations/example_softplus.f90!}
+```
+
 ## `Softplus_grad` - Gradient of the Softplus function
 
 ### Status
@@ -662,7 +677,7 @@ $$f(x) = \frac{\exp(x)}{\exp(x)+1} $$
 
 ### Syntax
 
-`result = ` [[stdlib_specialfunctions(module):Softplus_grad(interface)]] ` (x)`
+`result = ` [[stdlib_specialfunctions(module):softplus_grad(interface)]] ` (x)`
 
 ### Class
 

example/specialfunctions_activations/CMakeLists.txt

@@ -4,3 +4,7 @@ ADD_EXAMPLE(gelu)
 ADD_EXAMPLE(relu)
 ADD_EXAMPLE(selu)
 ADD_EXAMPLE(silu)
+ADD_EXAMPLE(softmax)
+ADD_EXAMPLE(logsoftmax)
+ADD_EXAMPLE(softplus)
+ADD_EXAMPLE(step)

example/specialfunctions_activations/example_elu.f90

@@ -9,5 +9,6 @@ program example_elu
 
     x = linspace(-2._sp, 2._sp, n)
     y = elu( x , 1.0 )
+    print *, y
 end program example_elu
 

example/specialfunctions_activations/example_gaussian.f90

@@ -9,5 +9,6 @@ program example_gaussian
 
     x = linspace(-2._sp, 2._sp, n)
     y = gaussian( x )
+    print *, y
 end program example_gaussian
 

example/specialfunctions_activations/example_gelu.f90

@@ -9,5 +9,6 @@ program example_gelu
 
     x = linspace(-2._sp, 2._sp, n)
     y = gelu( x )
+    print *, y
 end program example_gelu
 

example/specialfunctions_activations/example_logsoftmax.f90

@@ -0,0 +1,14 @@
+program example_logsoftmax
+    use stdlib_kinds, only: sp
+    use stdlib_math, only: linspace
+    use stdlib_specialfunctions, only: logsoftmax
+    
+    integer, parameter :: n = 10
+    real(sp) :: x(n), y(n)
+    implicit none
+  
+    x = linspace(-2._sp, 2._sp, n)
+    y = logsoftmax( x )
+    print *, y
+end program example_logsoftmax
+  

example/specialfunctions_activations/example_relu.f90

@@ -9,5 +9,6 @@ program example_relu
 
     x = linspace(-2._sp, 2._sp, n)
     y = relu( x )
+    print *, y
 end program example_relu
 

example/specialfunctions_activations/example_selu.f90

@@ -9,5 +9,6 @@ program example_selu
 
     x = linspace(-2._sp, 2._sp, n)
     y = selu( x )
+    print *, y
 end program example_selu
 

example/specialfunctions_activations/example_silu.f90

@@ -9,5 +9,6 @@ program example_silu
 
     x = linspace(-2._sp, 2._sp, n)
     y = silu( x )
+    print *, y
 end program example_silu
 

example/specialfunctions_activations/example_softmax.f90

@@ -0,0 +1,14 @@
+program example_softmax
+    use stdlib_kinds, only: sp
+    use stdlib_math, only: linspace
+    use stdlib_specialfunctions, only: softmax
+    
+    integer, parameter :: n = 10
+    real(sp) :: x(n), y(n)
+    implicit none
+  
+    x = linspace(-2._sp, 2._sp, n)
+    y = softmax( x )
+    print *, y
+end program example_softmax
+