| <!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>org.apache.sysds.api.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="org.apache.sysds.api.mlcontext (SystemDS 2.1.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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/jmlc/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/sysds/common/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/sysds/api/mlcontext/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.sysds.api.mlcontext</h1> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sysds/api/mlcontext/Frame.html" title="class in org.apache.sysds.api.mlcontext">Frame</a></td> |
| <td class="colLast"> |
| <div class="block">Frame encapsulates a SystemDS frame.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sysds/api/mlcontext/FrameMetadata.html" title="class in org.apache.sysds.api.mlcontext">FrameMetadata</a></td> |
| <td class="colLast"> |
| <div class="block">Frame metadata, such as the number of rows, the number of columns, the number |
| of non-zero values, the number of rows per block, and the number of columns |
| per block in the frame.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sysds/api/mlcontext/FrameSchema.html" title="class in org.apache.sysds.api.mlcontext">FrameSchema</a></td> |
| <td class="colLast"> |
| <div class="block">The frame schema, stored as a list of <code>ValueType</code> values.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sysds/api/mlcontext/Matrix.html" title="class in org.apache.sysds.api.mlcontext">Matrix</a></td> |
| <td class="colLast"> |
| <div class="block">Matrix encapsulates a SystemDS matrix.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sysds/api/mlcontext/MatrixMetadata.html" title="class in org.apache.sysds.api.mlcontext">MatrixMetadata</a></td> |
| <td class="colLast"> |
| <div class="block">Matrix metadata, such as the number of rows, the number of columns, the |
| number of non-zero values, the number of rows per block, and the number of |
| columns per block in the matrix.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sysds/api/mlcontext/Metadata.html" title="class in org.apache.sysds.api.mlcontext">Metadata</a></td> |
| <td class="colLast"> |
| <div class="block">Abstract metadata class for MLContext API.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.html" title="class in org.apache.sysds.api.mlcontext">MLContext</a></td> |
| <td class="colLast"> |
| <div class="block">The MLContext API offers programmatic access to SystemDS on Spark from |
| languages such as Scala, Java, and Python.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContextConversionUtil.html" title="class in org.apache.sysds.api.mlcontext">MLContextConversionUtil</a></td> |
| <td class="colLast"> |
| <div class="block">Utility class containing methods to perform data conversions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContextUtil.html" title="class in org.apache.sysds.api.mlcontext">MLContextUtil</a></td> |
| <td class="colLast"> |
| <div class="block">Utility class containing methods for working with the MLContext API.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sysds/api/mlcontext/MLResults.html" title="class in org.apache.sysds.api.mlcontext">MLResults</a></td> |
| <td class="colLast"> |
| <div class="block">MLResults handles the results returned from executing a Script using the |
| MLContext API.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sysds/api/mlcontext/ProjectInfo.html" title="class in org.apache.sysds.api.mlcontext">ProjectInfo</a></td> |
| <td class="colLast"> |
| <div class="block">Obtains information that is stored in the manifest when the SystemDS jar is |
| built.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sysds/api/mlcontext/Script.html" title="class in org.apache.sysds.api.mlcontext">Script</a></td> |
| <td class="colLast"> |
| <div class="block">A Script object encapsulates a DML or PYDML script.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sysds/api/mlcontext/ScriptExecutor.html" title="class in org.apache.sysds.api.mlcontext">ScriptExecutor</a></td> |
| <td class="colLast"> |
| <div class="block">ScriptExecutor executes a DML or PYDML Script object using SystemDS.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sysds/api/mlcontext/ScriptFactory.html" title="class in org.apache.sysds.api.mlcontext">ScriptFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Factory for creating DML and PYDML Script objects from strings, files, URLs, |
| and input streams.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sysds/api/mlcontext/FrameFormat.html" title="enum in org.apache.sysds.api.mlcontext">FrameFormat</a></td> |
| <td class="colLast"> |
| <div class="block">FrameFormat represents the different frame formats supported by the MLContext |
| API.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sysds/api/mlcontext/MatrixFormat.html" title="enum in org.apache.sysds.api.mlcontext">MatrixFormat</a></td> |
| <td class="colLast"> |
| <div class="block">MatrixFormat represents the different matrix formats supported by the |
| MLContext API.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.ExecutionType.html" title="enum in org.apache.sysds.api.mlcontext">MLContext.ExecutionType</a></td> |
| <td class="colLast"> |
| <div class="block">The different types of execution environments supported by SystemDS.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContext.ExplainLevel.html" title="enum in org.apache.sysds.api.mlcontext">MLContext.ExplainLevel</a></td> |
| <td class="colLast"> |
| <div class="block">The different explain levels supported by SystemDS.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/sysds/api/mlcontext/MLContextException.html" title="class in org.apache.sysds.api.mlcontext">MLContextException</a></td> |
| <td class="colLast"> |
| <div class="block">Uncaught exception representing SystemDS exceptions that occur through the |
| MLContext API.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| <!-- ======= 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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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/jmlc/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/sysds/common/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/sysds/api/mlcontext/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <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> |
