[madlib] 02/02: update user docs for new object_table param

[kh...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

khannaekta pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/madlib.git

commit 93cfa565088c61cf741111ebf56e5eab9f012577
Author: Frank McQuillan <fm...@pivotal.io>
AuthorDate: Wed May 27 12:50:30 2020 -0700

    update user docs for new object_table param
---
 .../madlib_keras_model_selection.sql_in             | 21 +++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

diff --git a/src/ports/postgres/modules/deep_learning/madlib_keras_model_selection.sql_in b/src/ports/postgres/modules/deep_learning/madlib_keras_model_selection.sql_in
index 7903e7f..d6c10e3 100644
--- a/src/ports/postgres/modules/deep_learning/madlib_keras_model_selection.sql_in
+++ b/src/ports/postgres/modules/deep_learning/madlib_keras_model_selection.sql_in
@@ -59,7 +59,8 @@ load_model_selection_table(
     model_selection_table,
     model_id_list,
     compile_params_list,
-    fit_params_list
+    fit_params_list,
+    object_table
     )
 </pre>
 
@@ -87,7 +88,10 @@ load_model_selection_table(
   <dt>compile_params_list</dt>
   <dd>VARCHAR[]. Array of compile parameters to be tested.  Each element
   of the array should consist of a string of compile parameters
-  exactly as it is to be passed to Keras.
+  exactly as it is to be passed to Keras. For custom loss functions or custom metrics,
+  list the custom function name in the usual way, and also provide the name of the
+  table where the serialized objects reside in the parameter 'object_table'
+  below.
   </dd>
 
   <dt>fit_params_list</dt>
@@ -96,6 +100,12 @@ load_model_selection_table(
   exactly as it is to be passed to Keras.
   </dd>
 
+  <dt>object_table (optional)</dt>
+  <dd>VARCHAR, default: NULL. Name of the table containing Python objects in the case that
+  custom loss functions or custom metrics are specified in the
+  parameter 'compile_params_list'.
+  </dd>
+
 </dl>
 
 <b>Output table</b>
@@ -133,6 +143,13 @@ load_model_selection_table(
         model architecture IDs.
         </td>
       </tr>
+      <tr>
+        <th>object_table</th>
+        <td>VARCHAR. Name of the object table containing the serialized
+        Python objects for custom loss functions and custom metrics.
+        If there are none, this field will be blank.
+        </td>
+      </tr>
     </table>
 </br>