blob: 888c4248879afdf4fad5d4247769cc7f97b3814c [file] [log] [blame]
<!DOCTYPE html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js"> <!--<![endif]-->
<head>
<title>SystemML Documentation - SystemML 1.1.0</title>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta name="description" content="SystemML Documentation">
<meta name="viewport" content="width=device-width">
<link rel="stylesheet" href="css/bootstrap.min.css">
<link rel="stylesheet" href="css/main.css">
<link rel="stylesheet" href="css/pygments-default.css">
<link rel="shortcut icon" href="img/favicon.png">
</head>
<body>
<!--[if lt IE 7]>
<p class="chromeframe">You are using an outdated browser. <a href="http://browsehappy.com/">Upgrade your browser today</a> or <a href="http://www.google.com/chromeframe/?redirect=true">install Google Chrome Frame</a> to better experience this site.</p>
<![endif]-->
<header class="navbar navbar-default navbar-fixed-top" id="topbar">
<div class="container">
<div class="navbar-header">
<div class="navbar-brand brand projectlogo">
<a href="http://systemml.apache.org/"><img class="logo" src="img/systemml-logo.png" alt="Apache SystemML" title="Apache SystemML"/></a>
</div>
<div class="navbar-brand brand projecttitle">
<a href="http://systemml.apache.org/">Apache SystemML<sup id="trademark"></sup></a><br/>
<span class="version">1.1.0</span>
</div>
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<nav class="navbar-collapse collapse">
<ul class="nav navbar-nav navbar-right">
<li><a href="index.html">Overview</a></li>
<li><a href="https://github.com/apache/systemml">GitHub</a></li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation<b class="caret"></b></a>
<ul class="dropdown-menu" role="menu">
<li><b>Running SystemML:</b></li>
<li><a href="https://github.com/apache/systemml">SystemML GitHub README</a></li>
<li><a href="spark-mlcontext-programming-guide.html">Spark MLContext</a></li>
<li><a href="spark-batch-mode.html">Spark Batch Mode</a>
<li><a href="hadoop-batch-mode.html">Hadoop Batch Mode</a>
<li><a href="standalone-guide.html">Standalone Guide</a></li>
<li><a href="jmlc.html">Java Machine Learning Connector (JMLC)</a>
<li class="divider"></li>
<li><b>Language Guides:</b></li>
<li><a href="dml-language-reference.html">DML Language Reference</a></li>
<li><a href="beginners-guide-to-dml-and-pydml.html">Beginner's Guide to DML and PyDML</a></li>
<li><a href="beginners-guide-python.html">Beginner's Guide for Python Users</a></li>
<li><a href="python-reference.html">Reference Guide for Python Users</a></li>
<li class="divider"></li>
<li><b>ML Algorithms:</b></li>
<li><a href="algorithms-reference.html">Algorithms Reference</a></li>
<li class="divider"></li>
<li><b>Tools:</b></li>
<li><a href="debugger-guide.html">Debugger Guide</a></li>
<li><a href="developer-tools-systemml.html">IDE Guide</a></li>
<li class="divider"></li>
<li><b>Other:</b></li>
<li><a href="contributing-to-systemml.html">Contributing to SystemML</a></li>
<li><a href="engine-dev-guide.html">Engine Developer Guide</a></li>
<li><a href="troubleshooting-guide.html">Troubleshooting Guide</a></li>
<li><a href="release-process.html">Release Process</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">API Docs<b class="caret"></b></a>
<ul class="dropdown-menu" role="menu">
<li><a href="./api/java/index.html">Java</a></li>
<li><a href="./api/python/index.html">Python</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Issues<b class="caret"></b></a>
<ul class="dropdown-menu" role="menu">
<li><b>JIRA:</b></li>
<li><a href="https://issues.apache.org/jira/browse/SYSTEMML">SystemML JIRA</a></li>
</ul>
</li>
</ul>
</nav>
</div>
</header>
<div class="container" id="content">
<h1 class="title">SystemML Documentation</h1>
<!--
-->
<p>SystemML is a flexible, scalable machine learning system.
SystemML&#8217;s distinguishing characteristics are:</p>
<ol>
<li><strong>Algorithm customizability via R-like and Python-like languages</strong>.</li>
<li><strong>Multiple execution modes</strong>, including Spark MLContext, Spark Batch, Hadoop Batch, Standalone, and JMLC.</li>
<li><strong>Automatic optimization</strong> based on data and cluster characteristics to ensure both efficiency and scalability.</li>
</ol>
<p>The <a href="https://github.com/apache/systemml">SystemML GitHub README</a> describes
building, testing, and running SystemML. Please read <a href="contributing-to-systemml">Contributing to SystemML</a>
to find out how to help make SystemML even better!</p>
<p>To download SystemML, visit the <a href="http://systemml.apache.org/download">downloads</a> page.</p>
<p>This version of SystemML supports: Java 8+, Scala 2.11+, Python 2.7/3.5+, Hadoop 2.6+, and Spark 2.1+.</p>
<h2 id="running-systemml">Running SystemML</h2>
<ul>
<li><a href="beginners-guide-python">Beginner&#8217;s Guide For Python Users</a> - Beginner&#8217;s Guide for Python users.</li>
<li><a href="spark-mlcontext-programming-guide">Spark MLContext</a> - Spark MLContext is a programmatic API
for running SystemML from Spark via Scala, Python, or Java.
<ul>
<li><a href="spark-mlcontext-programming-guide#spark-shell-example">Spark Shell Example (Scala)</a></li>
<li><a href="spark-mlcontext-programming-guide#jupyter-pyspark-notebook-example---poisson-nonnegative-matrix-factorization">Jupyter Notebook Example (PySpark)</a></li>
</ul>
</li>
<li><a href="spark-batch-mode">Spark Batch</a> - Algorithms are automatically optimized to run across Spark clusters.</li>
<li><a href="hadoop-batch-mode">Hadoop Batch</a> - Algorithms are automatically optimized when distributed across Hadoop clusters.</li>
<li><a href="standalone-guide">Standalone</a> - Standalone mode allows data scientists to rapidly prototype algorithms on a single
machine in R-like and Python-like declarative languages.</li>
<li><a href="jmlc">JMLC</a> - Java Machine Learning Connector.</li>
<li><a href="deep-learning">Deep Learning with SystemML</a>
<ul>
<li><em>Experimental</em> Caffe2DML API for Deep Learning (<a href="beginners-guide-caffe2dml">beginner&#8217;s guide</a>, <a href="reference-guide-caffe2dml">reference guide</a>) - Converts a Caffe specification to DML.</li>
<li><em>Experimental</em> <a href="beginners-guide-keras2dml">Keras2DML API</a> for Deep Learning.</li>
</ul>
</li>
</ul>
<h2 id="language-guides">Language Guides</h2>
<ul>
<li><a href="python-reference">Python API Reference</a> - API Reference Guide for Python users.</li>
<li><a href="dml-language-reference">DML Language Reference</a> -
DML is a high-level R-like declarative language for machine learning.</li>
<li><strong>PyDML Language Reference</strong> -
PyDML is a high-level Python-like declarative language for machine learning.</li>
<li><a href="beginners-guide-to-dml-and-pydml">Beginner&#8217;s Guide to DML and PyDML</a> -
An introduction to the basics of DML and PyDML.</li>
</ul>
<h2 id="ml-algorithms">ML Algorithms</h2>
<ul>
<li><a href="algorithms-reference">Algorithms Reference</a> - The Algorithms Reference describes the
machine learning algorithms included with SystemML in detail.</li>
</ul>
<h2 id="tools">Tools</h2>
<ul>
<li><a href="debugger-guide">Debugger Guide</a> - SystemML supports DML script-level debugging through a
command-line interface.</li>
<li><a href="developer-tools-systemml">IDE Guide</a> - Useful IDE Guide for Developing SystemML.</li>
</ul>
<h2 id="other">Other</h2>
<ul>
<li><a href="contributing-to-systemml">Contributing to SystemML</a> - Describes ways to contribute to SystemML.</li>
<li><a href="engine-dev-guide">Engine Developer Guide</a> - Guide for internal SystemML engine development.</li>
<li><a href="troubleshooting-guide">Troubleshooting Guide</a> - Troubleshoot various issues related to SystemML.</li>
<li><a href="release-process">Release Process</a> - Description of the SystemML release process.</li>
<li><a href="native-backend">Using Native BLAS</a> in SystemML.</li>
</ul>
</div> <!-- /container -->
<script src="js/vendor/jquery-1.12.0.min.js"></script>
<script src="js/vendor/bootstrap.min.js"></script>
<script src="js/vendor/anchor.min.js"></script>
<script src="js/main.js"></script>
<!-- Analytics -->
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-71553733-1', 'auto');
ga('send', 'pageview');
</script>
<!-- MathJax Section -->
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
TeX: { equationNumbers: { autoNumber: "AMS" } }
});
</script>
<script>
// Note that we load MathJax this way to work with local file (file://), HTTP and HTTPS.
// We could use "//cdn.mathjax...", but that won't support "file://".
(function(d, script) {
script = d.createElement('script');
script.type = 'text/javascript';
script.async = true;
script.onload = function(){
MathJax.Hub.Config({
tex2jax: {
inlineMath: [ ["$", "$"], ["\\\\(","\\\\)"] ],
displayMath: [ ["$$","$$"], ["\\[", "\\]"] ],
processEscapes: true,
skipTags: ['script', 'noscript', 'style', 'textarea', 'pre']
}
});
};
script.src = ('https:' == document.location.protocol ? 'https://' : 'http://') +
'cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML';
d.getElementsByTagName('head')[0].appendChild(script);
}(document));
</script>
</body>
</html>