[MachineLearning.Train] Modify remarks of Layer class and AddLayer method
authorHyunil <hyunil46.park@samsung.com>
Wed, 13 Jul 2022 06:18:31 +0000 (15:18 +0900)
committerJijoong Moon <jijoong.moon@samsung.com>
Tue, 23 Aug 2022 05:50:26 +0000 (14:50 +0900)
- Add comment about Disposed() of Layer class
- Add comment about AddLayer instance

Signed-off-by: Hyunil <hyunil46.park@samsung.com>
src/Tizen.MachineLearning.Train/Tizen.MachineLearning.Train/Layer.cs
src/Tizen.MachineLearning.Train/Tizen.MachineLearning.Train/Model.cs

index 66f4f35..518da43 100644 (file)
@@ -24,8 +24,9 @@ namespace Tizen.MachineLearning.Train
     /// </summary>
     /// <remarks>
     /// Use this function to create neural network layer.
-    /// If the function succeeds, layer must be released using Destroy(), if not added to a model.
-    /// If added to a model, layer is available until the model is released.
+    /// If the function succeeds, layer must be released using Disposed(), if not added to a model.
+    /// If added to a model by AddLayer method of Model, layer is available until the model is released. so
+    /// Disposed() must never be used.
     /// </remarks>
     /// <since_tizen> 10 </since_tizen>
     public class Layer: IDisposable
@@ -105,6 +106,7 @@ namespace Tizen.MachineLearning.Train
         /// </summary>
         /// <remarks>
         /// Use this function to set neural network layer Property.
+        /// The input format of property must be 'key = value' format.
         /// </remarks>
         /// <param name="property">property for layer.</param>
         /// <since_tizen> 10 </since_tizen>
index 08813b5..62dfa30 100644 (file)
@@ -264,6 +264,9 @@ namespace Tizen.MachineLearning.Train
         /// <remarks>
         /// Use this function to get already created Neural Network Layer.
         /// The returned layer must not be deleted as it is owned by the model.
+        /// layerName can be set by SetProperty method of Layer.
+        /// Returned layer instance is different with same layerName, but the
+        /// Internal native layer handle is same.
         /// </remarks>
         /// <param name="layerName"> Name of the already created layer.</param>
         /// <returns>layer instance</returns>