phaniarnab commented on a change in pull request #899:
URL: https://github.com/apache/systemml/pull/899#discussion_r415132839
##########
File path: src/main/java/org/apache/sysds/api/jmlc/PreparedScript.java
##########
@@ -476,8 +476,14 @@ public String explain() {
/**
* Capture lineage of the DML/PyDML program and view result as a string.
- *
- * @return string results of lineage trace
+ *
+ * @param var Capture lineage as string
+ *
Review comment:
Var is the output variable name on which lineage trace is sought.
##########
File path: src/main/java/org/apache/sysds/api/jmlc/PreparedScript.java
##########
@@ -476,8 +476,14 @@ public String explain() {
/**
* Capture lineage of the DML/PyDML program and view result as a string.
- *
- * @return string results of lineage trace
+ *
+ * @param var Capture lineage as string
+ *
+ * @return string results of lineage trace, for example, in case of
L2SVM
+ * > (53) (L) 0·SCALAR·INT64·true
+ * > (32) (L) 1·SCALAR·INT64·true
+ * > (47) (L) X·MATRIX·FP64·false
+ *
Review comment:
This is incomplete. Lineage trace for L2SVM is much bigger. Please
remove this example. In fact, for this routine, python doc is already quite
sound.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
