From 2464af2f2e28ff676297d8f1810b2edecd21290d Mon Sep 17 00:00:00 2001
From: lingbai-kong <oc371@tongji.edu.cn>
Date: Sat, 27 May 2023 16:21:14 +0800
Subject: [PATCH] Add: constructors and comments for ActivationAdaptor

---
 .../Keras/Activations/Activations.cs          | 56 ++++++++++++-------
 src/TensorFlowNET.Keras/Activations.cs        |  7 +++
 2 files changed, 42 insertions(+), 21 deletions(-)

diff --git a/src/TensorFlowNET.Core/Keras/Activations/Activations.cs b/src/TensorFlowNET.Core/Keras/Activations/Activations.cs
index 4a0222e9..ea01b319 100644
--- a/src/TensorFlowNET.Core/Keras/Activations/Activations.cs
+++ b/src/TensorFlowNET.Core/Keras/Activations/Activations.cs
@@ -26,42 +26,56 @@ namespace Tensorflow.Keras
             };
         }
     }
+
+    /// <summary>
+    /// The ActivationAdaptor is used to store string, Activation, and Func for Laysers Api to accept different types of activation parameters.
+    /// One of the properties must be specified while initializing.
+    /// </summary>
     public class ActivationAdaptor
     {
-        public string? Name { get; set; }
+        /// <summary>
+        /// The name of activaiton function, such as `tanh`, `sigmoid`.
+        /// </summary>
+        public string? Name { get; set; } = null;
+
+        /// <summary>
+        /// The available Activation instance of activaiton function, such as keras.activations.Tanh, keras.activations.Sigmoid.
+        /// </summary>
+        public Activation? Activation { get; set; } = null;
+
+        /// <summary>
+        /// The Func definition of activation function, which can be customized.
+        /// </summary>
+        public Func<Tensor, string, Tensor>? Func { get; set; } = null;
+
+        public ActivationAdaptor(string name)
+        {
+            Name = name;
+        }
 
-        public Activation? Activation { get; set; }
+        public ActivationAdaptor(Activation activation)
+        {
+            Activation = activation;
+        }
 
-        public Func<Tensor, string, Tensor>? Func { get; set; }
+        public ActivationAdaptor(Func<Tensor, string, Tensor> func)
+        {
+            Func = func;
+        }
 
         public static implicit operator ActivationAdaptor(string name)
         {
-            return new ActivationAdaptor()
-            {
-                Name = name,
-                Activation = null,
-                Func = null
-            };
+            return new ActivationAdaptor(name);
         }
 
         public static implicit operator ActivationAdaptor(Activation activation)
         {
-            return new ActivationAdaptor()
-            {
-                Name = null,
-                Activation = activation,
-                Func = null
-            };
+            return new ActivationAdaptor(activation);
         }
 
         public static implicit operator ActivationAdaptor(Func<Tensor, string, Tensor> func)
         {
-            return new ActivationAdaptor()
-            {
-                Name = null,
-                Activation = null,
-                Func = func
-            };
+            return new ActivationAdaptor(func);
         }
     }
 
diff --git a/src/TensorFlowNET.Keras/Activations.cs b/src/TensorFlowNET.Keras/Activations.cs
index e26a97bd..4d08c77e 100644
--- a/src/TensorFlowNET.Keras/Activations.cs
+++ b/src/TensorFlowNET.Keras/Activations.cs
@@ -93,6 +93,13 @@ namespace Tensorflow.Keras
             }
         }
 
+        /// <summary>
+        /// Convert ActivationAdaptor to Activation.
+        /// If more than one properties of ActivationAdaptor are specified, the order of priority is `Name`, `Activation`, `Func`
+        /// </summary>
+        /// <param name="adaptor"></param>
+        /// <returns></returns>
+        /// <exception cref="Exception"></exception>
         public Activation GetActivationFromAdaptor(ActivationAdaptor adaptor)
         {
             if(adaptor == null)