From 7873c4557d5c9d038850440c7aeca95abef5c7ec Mon Sep 17 00:00:00 2001 From: Hossein Moein Date: Fri, 17 Nov 2023 11:03:41 -0500 Subject: [PATCH] Enhanced docs --- docs/HTML/BoxCoxVisitor.html | 38 ++++++++++++++++++++++++++------- docs/HTML/LossFuncVisitor.html | 39 ++++++++++++++++++++++++++-------- docs/HTML/ReturnVisitor.html | 26 +++++++++++++++++++++-- docs/HTML/SigmoidVisitor.html | 38 ++++++++++++++++++++++++++------- 4 files changed, 114 insertions(+), 27 deletions(-) diff --git a/docs/HTML/BoxCoxVisitor.html b/docs/HTML/BoxCoxVisitor.html index 642f5b8a5..6f745ff8b 100644 --- a/docs/HTML/BoxCoxVisitor.html +++ b/docs/HTML/BoxCoxVisitor.html @@ -24,6 +24,28 @@ --> + + + @@ -35,20 +57,20 @@ diff --git a/docs/HTML/LossFuncVisitor.html b/docs/HTML/LossFuncVisitor.html index 9a1b1bbda..d4d170b53 100644 --- a/docs/HTML/LossFuncVisitor.html +++ b/docs/HTML/LossFuncVisitor.html @@ -24,8 +24,29 @@ --> - + + +

 enum class box_cox_type : unsigned char  {
-    // y(λ) = (yλ - 1) / λ,  if λ != 0
-    // y(λ) = log(y),        if λ == 0
+    // y(λ) = 
 yλ - 1 / λ
    if λ != 0
+    // y(λ) = log(y)    if λ == 0
     original = 1,
 
-    // y(λ) = (yλ - 1) / (λ * GM(λ - 1)),  if λ != 0
-    // y(λ) = GM * log(y),               if λ == 0
+    // y(λ) = 
 yλ - 1 /  λ * GM(λ - 1) 
    if λ != 0
+    // y(λ) = GM * log(y)      if λ == 0
     geometric_mean = 2,
 
-    // y(λ) = sign(y) * (((|y| + 1)λ - 1) / λ),  if λ != 0
-    // y(λ) = sign(y) * log(|y| + 1),           if λ == 0
+    // y(λ) = sign(y) * 
(|y| + 1)λ - 1 / λ 
    if λ != 0
+    // y(λ) = sign(y) * log(|y| + 1)      if λ == 0
     modulus = 3,
 
-    // y(λ) = (eλy - 1) / λ,  if λ != 0
-    // y(λ) = y,              if λ == 0
+    // y(λ) = 
eλy - 1 / λ
   if λ != 0
+    // y(λ) = y         if λ == 0
     exponential = 4,
 };
@@ -36,31 +57,31 @@ 

 enum class loss_function_type : unsigned char  {
     // P = Probability(Actual), Q = Probability(Model)
-    kullback_leibler = 1,      // L = ∑[P(x) * log(P(x) / Q(x))]
+    kullback_leibler = 1,      // L = ∑[P(x) * log 
 P(x) / Q(x)
]
 
     // y = Actual, ŷ = Model
-    mean_abs_error = 2,        // L = ∑[|yi - ŷi|] / N
+    mean_abs_error = 2,        // L = 
 ∑|yi - ŷi| / N 

 
     // y = Actual, ŷ = Model
-    mean_sqr_error = 3,        // L = ∑[(yi - ŷi)2] / N
+    mean_sqr_error = 3,        // L = 
 ∑(yi - ŷi)2 / N 

 
     // y = Actual, ŷ = Model
-    mean_sqr_log_error = 4,    // L = ∑[(log(1 + yi) - log(1 + ŷi))2] / N
+    mean_sqr_log_error = 4,    // L = 
 ∑[(log(1 + yi) - log(1 + ŷi))2] / N 

 
     // y = Actual, P(yi) = Model probability prediction
-    cross_entropy = 5,         // L = -∑[yi * log(P(yi))] / N
+    cross_entropy = 5,         // L = 
 -∑[yi * log(P(yi))] / N 

 
     // y = Actual binary (0/1), P(yi) = Model probability prediction
-    binary_cross_entropy = 6,  // L = ∑[-(yi * log(P(yi))) + (1 - yi) * log(1 - P(yi))] / N
+    binary_cross_entropy = 6,  // L = 
 ∑[-(yi * log(P(yi))) + (1 - yi) * log(1 - P(yi))] / N 

 
     // y = Actual, ŷ = Model
     categorical_hinge = 7,     // L = max[∑[(1 - yi) * ŷi] - ∑[yi * ŷi] + 1, 0]
 
     // Y = Actual, Ŷ = Model
-    cosine_similarity = 8,     // L = (Y . Ŷ) / (||Y|| * ||Ŷ||)
+    cosine_similarity = 8,     // L = 
 Y . Ŷ / ||Y|| * ||Ŷ|| 

 
     // y = Actual, ŷ = Model
-    log_cosh = 9,              // L = ∑[log(cosh(ŷi - yi))] / N
+    log_cosh = 9,              // L = 
 ∑log(cosh(ŷi - yi)) / N 

 };
diff --git a/docs/HTML/ReturnVisitor.html b/docs/HTML/ReturnVisitor.html index 2f974afba..4db289f5e 100644 --- a/docs/HTML/ReturnVisitor.html +++ b/docs/HTML/ReturnVisitor.html @@ -24,6 +24,28 @@ --> + + + @@ -35,8 +57,8 @@ 

 enum class return_policy : unsigned char  {
-    log = 1,         // log(Xt / Xt-1)
-    percentage = 2,  // (Xt - Xt-1) / Xt-1
+    log = 1,         // log 
 Xt / Xt-1 

+    percentage = 2,  // 
 Xt - Xt-1 / Xt-1 

     monetary = 3,    // Xt - Xt-1
     trinary = 4,     // 1 if Xt - Xt-1 > 0, -1 if Xt - Xt-1 < 0, else 0
 };
diff --git a/docs/HTML/SigmoidVisitor.html b/docs/HTML/SigmoidVisitor.html
index 96e8463b3..3d92a82e2 100644
--- a/docs/HTML/SigmoidVisitor.html
+++ b/docs/HTML/SigmoidVisitor.html
@@ -24,6 +24,28 @@
 -->
 
 
+
+
+
 
 
   
@@ -34,11 +56,11 @@
       
 
         

 enum class sigmoid_type : unsigned char  {
-    logistic = 1,        // f(x) = 1 / (1 + e-x)
-    algebraic = 2,       // f(x) = 1 / √1 + x2
+    logistic = 1,        // f(x) = 
 1 / 1 + e-x 

+    algebraic = 2,       // f(x) = 
 1 / √1 + x2 

     hyperbolic_tan = 3,  // f(x) = tanh(x)
     arc_tan = 4,         // f(x) = atan(x)
-    error_function = 5,  // f(x) = 2 / √ℼ * ∫ e-t2 dt
+    error_function = 5,  // f(x) = 
 2 / √ℼ 
 * ∫ e-t2 dt
     gudermannian = 6,    // f(x) = atan(sinh(x))
     smoothstep = 7,      // f(x) = 0 if x <= 0, 1 if x >= 1, else 3x2 - 2x3
 };
 
@@ -60,13 +82,13 @@
         

 enum class  rectify_type : unsigned char  {
     ReLU = 1,           // f(x) = x if x > 0 else 0
-    param_ReLU = 2,     // f(x) = x if x > 0 else a * x,   a <= 1
-    GeLU = 3,           // f(x) = x * Φ(x),   Φ = Standard Normal Dist
+    param_ReLU = 2,     // f(x) = x if x > 0 else a * x    a <= 1
+    GeLU = 3,           // f(x) = x * Φ(x)    Φ = Standard Normal Dist
     SiLU = 4,           // f(x) = x * Sigmoid(x)
-    softplus = 5,       // f(x) = log(1 + ea * x) / a,   a != 0
-    elu = 6,            // f(x) = x if x > 0 else a * (ex - 1),   a >= 0
+    softplus = 5,       // f(x) = 
 log(1 + eax) / a 
    a != 0
+    elu = 6,            // f(x) = x if x > 0 else a * (ex - 1)    a >= 0
     mish = 7,           // f(x) = x * tanh(softplus(x))
-    metallic_mean = 8,  // f(x) = (x + √x2 + 4) / 2
+    metallic_mean = 8,  // f(x) = 
 x + √x2 + 4 / 2 

 };