| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>MLContext (SystemDS 2.1.0-SNAPSHOT API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="MLContext (SystemDS 2.1.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/MLContext.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/sysds/api/mlcontext/Metadata.html" title="class in org.apache.sysds.api.mlcontext"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.ExecutionType.html" title="enum in org.apache.sysds.api.mlcontext"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/sysds/api/mlcontext/MLContext.html" target="_top">Frames</a></li> |
| <li><a href="MLContext.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.sysds.api.mlcontext</div> |
| <h2 title="Class MLContext" class="title">Class MLContext</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.sysds.api.mlcontext.MLContext</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../org/apache/sysds/api/ConfigurableAPI.html" title="interface in org.apache.sysds.api">ConfigurableAPI</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">MLContext</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../org/apache/sysds/api/ConfigurableAPI.html" title="interface in org.apache.sysds.api">ConfigurableAPI</a></pre> |
| <div class="block">The MLContext API offers programmatic access to SystemDS on Spark from |
| languages such as Scala, Java, and Python.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.ExecutionType.html" title="enum in org.apache.sysds.api.mlcontext">MLContext.ExecutionType</a></span></code> |
| <div class="block">The different types of execution environments supported by SystemDS.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.ExplainLevel.html" title="enum in org.apache.sysds.api.mlcontext">MLContext.ExplainLevel</a></span></code> |
| <div class="block">The different explain levels supported by SystemDS.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.InternalProxy.html" title="class in org.apache.sysds.api.mlcontext">MLContext.InternalProxy</a></span></code> |
| <div class="block">Used internally by MLContextProxy.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#MLContext-org.apache.spark.api.java.JavaSparkContext-">MLContext</a></span>(org.apache.spark.api.java.JavaSparkContext javaSparkContext)</code> |
| <div class="block">Create an MLContext based on a JavaSparkContext for interaction with |
| SystemDS on Spark.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#MLContext-org.apache.spark.SparkContext-">MLContext</a></span>(org.apache.spark.SparkContext sparkContext)</code> |
| <div class="block">Create an MLContext based on a SparkContext for interaction with SystemDS |
| on Spark.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#MLContext-org.apache.spark.sql.SparkSession-">MLContext</a></span>(org.apache.spark.sql.SparkSession spark)</code> |
| <div class="block">Create an MLContext based on a SparkSession for interaction with SystemDS |
| on Spark.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#buildTime--">buildTime</a></span>()</code> |
| <div class="block">Obtain the SystemDS jar file build time.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#close--">close</a></span>()</code> |
| <div class="block">Closes the mlcontext, which includes the cleanup of static and local |
| state as well as scratch space and buffer pool cleanup.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/sysds/api/mlcontext/MLResults.html" title="class in org.apache.sysds.api.mlcontext">MLResults</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#execute-org.apache.sysds.api.mlcontext.Script-">execute</a></span>(<a href="../../../../../org/apache/sysds/api/mlcontext/Script.html" title="class in org.apache.sysds.api.mlcontext">Script</a> script)</code> |
| <div class="block">Execute a DML or PYDML Script.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/sysds/api/mlcontext/MLResults.html" title="class in org.apache.sysds.api.mlcontext">MLResults</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#execute-org.apache.sysds.api.mlcontext.Script-org.apache.sysds.api.mlcontext.ScriptExecutor-">execute</a></span>(<a href="../../../../../org/apache/sysds/api/mlcontext/Script.html" title="class in org.apache.sysds.api.mlcontext">Script</a> script, |
| <a href="../../../../../org/apache/sysds/api/mlcontext/ScriptExecutor.html" title="class in org.apache.sysds.api.mlcontext">ScriptExecutor</a> scriptExecutor)</code> |
| <div class="block">Execute a DML or PYDML Script object using a ScriptExecutor.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html" title="class in org.apache.sysds.api.mlcontext">MLContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#getActiveMLContext--">getActiveMLContext</a></span>()</code> |
| <div class="block">Retrieve the currently active MLContext.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.ExecutionType.html" title="enum in org.apache.sysds.api.mlcontext">MLContext.ExecutionType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#getExecutionType--">getExecutionType</a></span>()</code> |
| <div class="block">Obtain the current execution environment.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.InternalProxy.html" title="class in org.apache.sysds.api.mlcontext">MLContext.InternalProxy</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#getInternalProxy--">getInternalProxy</a></span>()</code> |
| <div class="block">Used internally by MLContextProxy.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>org.apache.spark.sql.SparkSession</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#getSparkSession--">getSparkSession</a></span>()</code> |
| <div class="block">Obtain the SparkSession associated with this MLContext.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#getStatisticsMaxHeavyHitters--">getStatisticsMaxHeavyHitters</a></span>()</code> |
| <div class="block">Obtain the maximum number of heavy hitters that are printed out as part |
| of the statistics.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/sysds/api/mlcontext/ProjectInfo.html" title="class in org.apache.sysds.api.mlcontext">ProjectInfo</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#info--">info</a></span>()</code> |
| <div class="block">Obtain information about the project such as version and build time from |
| the manifest in the SystemDS jar file.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#isExplain--">isExplain</a></span>()</code> |
| <div class="block">Whether or not an explanation of the DML/PYDML program should be output |
| to standard output.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#isForceGPU--">isForceGPU</a></span>()</code> |
| <div class="block">Whether or not the "force" GPU mode is enabled.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#isGPU--">isGPU</a></span>()</code> |
| <div class="block">Whether or not the GPU mode is enabled.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#isInitBeforeExecution--">isInitBeforeExecution</a></span>()</code> |
| <div class="block">Whether or not the default ScriptExecutor should be initialized before |
| execution.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#isMaintainSymbolTable--">isMaintainSymbolTable</a></span>()</code> |
| <div class="block">Obtain whether or not all values should be maintained in the symbol table |
| after execution.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#isStatistics--">isStatistics</a></span>()</code> |
| <div class="block">Whether or not statistics of the DML/PYDML program execution should be |
| output to standard output.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#resetConfig--">resetConfig</a></span>()</code> |
| <div class="block">Reset configuration settings to default settings.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#setConfig-java.lang.String-">setConfig</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> configFilePath)</code> |
| <div class="block">Set SystemDS configuration based on a configuration file.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#setConfigProperty-java.lang.String-java.lang.String-">setConfigProperty</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> propertyName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> propertyValue)</code> |
| <div class="block">Set configuration property, such as |
| <code>setConfigProperty("sysds.localtmpdir", "/tmp/systemds")</code>.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#setExecutionScript-org.apache.sysds.api.mlcontext.Script-">setExecutionScript</a></span>(<a href="../../../../../org/apache/sysds/api/mlcontext/Script.html" title="class in org.apache.sysds.api.mlcontext">Script</a> executionScript)</code> |
| <div class="block">Sets the script that is being executed</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#setExecutionType-org.apache.sysds.api.mlcontext.MLContext.ExecutionType-">setExecutionType</a></span>(<a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.ExecutionType.html" title="enum in org.apache.sysds.api.mlcontext">MLContext.ExecutionType</a> executionType)</code> |
| <div class="block">Set the execution environment.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#setExplain-boolean-">setExplain</a></span>(boolean explain)</code> |
| <div class="block">Whether or not an explanation of the DML/PYDML program should be output |
| to standard output.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#setExplainLevel-org.apache.sysds.api.mlcontext.MLContext.ExplainLevel-">setExplainLevel</a></span>(<a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.ExplainLevel.html" title="enum in org.apache.sysds.api.mlcontext">MLContext.ExplainLevel</a> explainLevel)</code> |
| <div class="block">Set the level of program explanation that should be displayed if explain |
| is set to true.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#setExplainLevel-java.lang.String-">setExplainLevel</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> explainLevel)</code> |
| <div class="block">Set the level of program explanation that should be displayed if explain |
| is set to true.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#setForceGPU-boolean-">setForceGPU</a></span>(boolean enable)</code> |
| <div class="block">Whether or not to explicitly "force" the usage of GPU.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#setGPU-boolean-">setGPU</a></span>(boolean enable)</code> |
| <div class="block">Whether or not to use (an available) GPU on the driver node.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#setInitBeforeExecution-boolean-">setInitBeforeExecution</a></span>(boolean initBeforeExecution)</code> |
| <div class="block">Whether or not the default ScriptExecutor should be initialized before |
| execution.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#setLineage-boolean-">setLineage</a></span>(boolean lineage)</code> |
| <div class="block">Set whether or not lineage should be traced</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#setLineage-org.apache.sysds.runtime.lineage.LineageCacheConfig.ReuseCacheType-">setLineage</a></span>(<a href="../../../../../org/apache/sysds/runtime/lineage/LineageCacheConfig.ReuseCacheType.html" title="enum in org.apache.sysds.runtime.lineage">LineageCacheConfig.ReuseCacheType</a> reuse)</code> |
| <div class="block">Set type of lineage-based reuse caching and enable lineage tracing</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#setMaintainSymbolTable-boolean-">setMaintainSymbolTable</a></span>(boolean maintainSymbolTable)</code> |
| <div class="block">Set whether or not all values should be maintained in the symbol table |
| after execution.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#setStatistics-boolean-">setStatistics</a></span>(boolean statistics)</code> |
| <div class="block">Whether or not statistics of the DML/PYDML program execution should be |
| output to standard output.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#setStatisticsMaxHeavyHitters-int-">setStatisticsMaxHeavyHitters</a></span>(int maxHeavyHitters)</code> |
| <div class="block">Sets the maximum number of heavy hitters that are printed out as part of |
| the statistics.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html#version--">version</a></span>()</code> |
| <div class="block">Obtain the SystemDS version number.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="MLContext-org.apache.spark.sql.SparkSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MLContext</h4> |
| <pre>public MLContext(org.apache.spark.sql.SparkSession spark)</pre> |
| <div class="block">Create an MLContext based on a SparkSession for interaction with SystemDS |
| on Spark.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>spark</code> - SparkSession</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="MLContext-org.apache.spark.SparkContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MLContext</h4> |
| <pre>public MLContext(org.apache.spark.SparkContext sparkContext)</pre> |
| <div class="block">Create an MLContext based on a SparkContext for interaction with SystemDS |
| on Spark.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sparkContext</code> - SparkContext</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="MLContext-org.apache.spark.api.java.JavaSparkContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>MLContext</h4> |
| <pre>public MLContext(org.apache.spark.api.java.JavaSparkContext javaSparkContext)</pre> |
| <div class="block">Create an MLContext based on a JavaSparkContext for interaction with |
| SystemDS on Spark.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>javaSparkContext</code> - JavaSparkContext</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getActiveMLContext--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getActiveMLContext</h4> |
| <pre>public static <a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html" title="class in org.apache.sysds.api.mlcontext">MLContext</a> getActiveMLContext()</pre> |
| <div class="block">Retrieve the currently active MLContext. This is used internally by |
| SystemDS via MLContextProxy.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the active MLContext</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resetConfig--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resetConfig</h4> |
| <pre>public void resetConfig()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/sysds/api/ConfigurableAPI.html#resetConfig--">ConfigurableAPI</a></code></span></div> |
| <div class="block">Reset configuration settings to default settings.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/sysds/api/ConfigurableAPI.html#resetConfig--">resetConfig</a></code> in interface <code><a href="../../../../../org/apache/sysds/api/ConfigurableAPI.html" title="interface in org.apache.sysds.api">ConfigurableAPI</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setConfigProperty-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConfigProperty</h4> |
| <pre>public void setConfigProperty(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> propertyName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> propertyValue)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/sysds/api/ConfigurableAPI.html#setConfigProperty-java.lang.String-java.lang.String-">ConfigurableAPI</a></code></span></div> |
| <div class="block">Set configuration property, such as |
| <code>setConfigProperty("sysds.localtmpdir", "/tmp/systemds")</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/sysds/api/ConfigurableAPI.html#setConfigProperty-java.lang.String-java.lang.String-">setConfigProperty</a></code> in interface <code><a href="../../../../../org/apache/sysds/api/ConfigurableAPI.html" title="interface in org.apache.sysds.api">ConfigurableAPI</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>propertyName</code> - property name</dd> |
| <dd><code>propertyValue</code> - property value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="execute-org.apache.sysds.api.mlcontext.Script-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre>public <a href="../../../../../org/apache/sysds/api/mlcontext/MLResults.html" title="class in org.apache.sysds.api.mlcontext">MLResults</a> execute(<a href="../../../../../org/apache/sysds/api/mlcontext/Script.html" title="class in org.apache.sysds.api.mlcontext">Script</a> script)</pre> |
| <div class="block">Execute a DML or PYDML Script.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>script</code> - The DML or PYDML Script object to execute.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the results as a MLResults object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="execute-org.apache.sysds.api.mlcontext.Script-org.apache.sysds.api.mlcontext.ScriptExecutor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre>public <a href="../../../../../org/apache/sysds/api/mlcontext/MLResults.html" title="class in org.apache.sysds.api.mlcontext">MLResults</a> execute(<a href="../../../../../org/apache/sysds/api/mlcontext/Script.html" title="class in org.apache.sysds.api.mlcontext">Script</a> script, |
| <a href="../../../../../org/apache/sysds/api/mlcontext/ScriptExecutor.html" title="class in org.apache.sysds.api.mlcontext">ScriptExecutor</a> scriptExecutor)</pre> |
| <div class="block">Execute a DML or PYDML Script object using a ScriptExecutor. The |
| ScriptExecutor class can be extended to allow the modification of the |
| default execution pathway.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>script</code> - the DML or PYDML Script object</dd> |
| <dd><code>scriptExecutor</code> - the ScriptExecutor that defines the script execution pathway</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the results as a MLResults object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setExecutionScript-org.apache.sysds.api.mlcontext.Script-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExecutionScript</h4> |
| <pre>public void setExecutionScript(<a href="../../../../../org/apache/sysds/api/mlcontext/Script.html" title="class in org.apache.sysds.api.mlcontext">Script</a> executionScript)</pre> |
| <div class="block">Sets the script that is being executed</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>executionScript</code> - script that is being executed</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setConfig-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConfig</h4> |
| <pre>public void setConfig(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> configFilePath)</pre> |
| <div class="block">Set SystemDS configuration based on a configuration file.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>configFilePath</code> - path to the configuration file</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSparkSession--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSparkSession</h4> |
| <pre>public org.apache.spark.sql.SparkSession getSparkSession()</pre> |
| <div class="block">Obtain the SparkSession associated with this MLContext.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the SparkSession associated with this MLContext.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isExplain--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isExplain</h4> |
| <pre>public boolean isExplain()</pre> |
| <div class="block">Whether or not an explanation of the DML/PYDML program should be output |
| to standard output.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if explanation should be output, <code>false</code> |
| otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setExplain-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExplain</h4> |
| <pre>public void setExplain(boolean explain)</pre> |
| <div class="block">Whether or not an explanation of the DML/PYDML program should be output |
| to standard output.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>explain</code> - <code>true</code> if explanation should be output, <code>false</code> otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLineage-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLineage</h4> |
| <pre>public void setLineage(boolean lineage)</pre> |
| <div class="block">Set whether or not lineage should be traced</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>lineage</code> - <code>true</code> if lineage should be traced, <code>false</code> otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLineage-org.apache.sysds.runtime.lineage.LineageCacheConfig.ReuseCacheType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLineage</h4> |
| <pre>public void setLineage(<a href="../../../../../org/apache/sysds/runtime/lineage/LineageCacheConfig.ReuseCacheType.html" title="enum in org.apache.sysds.runtime.lineage">LineageCacheConfig.ReuseCacheType</a> reuse)</pre> |
| <div class="block">Set type of lineage-based reuse caching and enable lineage tracing</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>reuse</code> - reuse cache type to use</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isMaintainSymbolTable--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMaintainSymbolTable</h4> |
| <pre>public boolean isMaintainSymbolTable()</pre> |
| <div class="block">Obtain whether or not all values should be maintained in the symbol table |
| after execution.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if all values should be maintained in the symbol |
| table, <code>false</code> otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaintainSymbolTable-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaintainSymbolTable</h4> |
| <pre>public void setMaintainSymbolTable(boolean maintainSymbolTable)</pre> |
| <div class="block">Set whether or not all values should be maintained in the symbol table |
| after execution.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maintainSymbolTable</code> - <code>true</code> if all values should be maintained in the symbol |
| table, <code>false</code> otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setExplainLevel-org.apache.sysds.api.mlcontext.MLContext.ExplainLevel-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExplainLevel</h4> |
| <pre>public void setExplainLevel(<a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.ExplainLevel.html" title="enum in org.apache.sysds.api.mlcontext">MLContext.ExplainLevel</a> explainLevel)</pre> |
| <div class="block">Set the level of program explanation that should be displayed if explain |
| is set to true.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>explainLevel</code> - the level of program explanation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setExplainLevel-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExplainLevel</h4> |
| <pre>public void setExplainLevel(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> explainLevel)</pre> |
| <div class="block">Set the level of program explanation that should be displayed if explain |
| is set to true.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>explainLevel</code> - string denoting program explanation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setGPU-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setGPU</h4> |
| <pre>public void setGPU(boolean enable)</pre> |
| <div class="block">Whether or not to use (an available) GPU on the driver node. If a GPU is |
| not available, and the GPU mode is set, SystemDS will crash when the |
| program is run.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>enable</code> - true if needs to be enabled, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setForceGPU-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setForceGPU</h4> |
| <pre>public void setForceGPU(boolean enable)</pre> |
| <div class="block">Whether or not to explicitly "force" the usage of GPU. If a GPU is not |
| available, and the GPU mode is set or if available memory on GPU is less, |
| SystemDS will crash when the program is run.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>enable</code> - true if needs to be enabled, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isGPU--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isGPU</h4> |
| <pre>public boolean isGPU()</pre> |
| <div class="block">Whether or not the GPU mode is enabled.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if enabled, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isForceGPU--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isForceGPU</h4> |
| <pre>public boolean isForceGPU()</pre> |
| <div class="block">Whether or not the "force" GPU mode is enabled.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if enabled, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInternalProxy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInternalProxy</h4> |
| <pre>public <a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.InternalProxy.html" title="class in org.apache.sysds.api.mlcontext">MLContext.InternalProxy</a> getInternalProxy()</pre> |
| <div class="block">Used internally by MLContextProxy.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>InternalProxy object used by MLContextProxy</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isStatistics--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isStatistics</h4> |
| <pre>public boolean isStatistics()</pre> |
| <div class="block">Whether or not statistics of the DML/PYDML program execution should be |
| output to standard output.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if statistics should be output, <code>false</code> |
| otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setStatistics-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStatistics</h4> |
| <pre>public void setStatistics(boolean statistics)</pre> |
| <div class="block">Whether or not statistics of the DML/PYDML program execution should be |
| output to standard output.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>statistics</code> - <code>true</code> if statistics should be output, <code>false</code> |
| otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setStatisticsMaxHeavyHitters-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStatisticsMaxHeavyHitters</h4> |
| <pre>public void setStatisticsMaxHeavyHitters(int maxHeavyHitters)</pre> |
| <div class="block">Sets the maximum number of heavy hitters that are printed out as part of |
| the statistics.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxHeavyHitters</code> - maximum number of heavy hitters to print</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close()</pre> |
| <div class="block">Closes the mlcontext, which includes the cleanup of static and local |
| state as well as scratch space and buffer pool cleanup. Note that the |
| spark context is not explicitly closed to allow external reuse.</div> |
| </li> |
| </ul> |
| <a name="info--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>info</h4> |
| <pre>public <a href="../../../../../org/apache/sysds/api/mlcontext/ProjectInfo.html" title="class in org.apache.sysds.api.mlcontext">ProjectInfo</a> info()</pre> |
| <div class="block">Obtain information about the project such as version and build time from |
| the manifest in the SystemDS jar file.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>information about the project</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="version--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>version</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> version()</pre> |
| <div class="block">Obtain the SystemDS version number.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the SystemDS version number</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="buildTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildTime</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> buildTime()</pre> |
| <div class="block">Obtain the SystemDS jar file build time.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the SystemDS jar file build time</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStatisticsMaxHeavyHitters--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStatisticsMaxHeavyHitters</h4> |
| <pre>public int getStatisticsMaxHeavyHitters()</pre> |
| <div class="block">Obtain the maximum number of heavy hitters that are printed out as part |
| of the statistics.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>maximum number of heavy hitters to print</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isInitBeforeExecution--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isInitBeforeExecution</h4> |
| <pre>public boolean isInitBeforeExecution()</pre> |
| <div class="block">Whether or not the default ScriptExecutor should be initialized before |
| execution.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if ScriptExecutor should be initialized before |
| execution, <code>false</code> otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setInitBeforeExecution-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInitBeforeExecution</h4> |
| <pre>public void setInitBeforeExecution(boolean initBeforeExecution)</pre> |
| <div class="block">Whether or not the default ScriptExecutor should be initialized before |
| execution.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>initBeforeExecution</code> - <code>true</code> if ScriptExecutor should be initialized before |
| execution, <code>false</code> otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getExecutionType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExecutionType</h4> |
| <pre>public <a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.ExecutionType.html" title="enum in org.apache.sysds.api.mlcontext">MLContext.ExecutionType</a> getExecutionType()</pre> |
| <div class="block">Obtain the current execution environment.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the execution environment</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setExecutionType-org.apache.sysds.api.mlcontext.MLContext.ExecutionType-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setExecutionType</h4> |
| <pre>public void setExecutionType(<a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.ExecutionType.html" title="enum in org.apache.sysds.api.mlcontext">MLContext.ExecutionType</a> executionType)</pre> |
| <div class="block">Set the execution environment.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>executionType</code> - the execution environment</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/MLContext.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/sysds/api/mlcontext/Metadata.html" title="class in org.apache.sysds.api.mlcontext"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.ExecutionType.html" title="enum in org.apache.sysds.api.mlcontext"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/sysds/api/mlcontext/MLContext.html" target="_top">Frames</a></li> |
| <li><a href="MLContext.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |