| |
| |
| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" > |
| <head> |
| <meta charset="utf-8"> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>Matrix — SystemDS 2.0.0 documentation</title> |
| |
| |
| |
| <link rel="stylesheet" href="../../static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../static/pygments.css" type="text/css" /> |
| |
| |
| |
| |
| |
| |
| |
| <!--[if lt IE 9]> |
| <script src="../../static/js/html5shiv.min.js"></script> |
| <![endif]--> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../static/documentation_options.js"></script> |
| <script src="../../static/jquery.js"></script> |
| <script src="../../static/underscore.js"></script> |
| <script src="../../static/doctools.js"></script> |
| <script src="../../static/language_data.js"></script> |
| |
| <script type="text/javascript" src="../../static/js/theme.js"></script> |
| |
| |
| <link rel="index" title="Index" href="../../genindex.html" /> |
| <link rel="search" title="Search" href="../../search.html" /> |
| <link rel="next" title="Federated" href="federated.html" /> |
| <link rel="prev" title="Data Generators" href="data_gen.html" /> |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../../index.html" class="icon icon-home" alt="Documentation Home"> SystemDS |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <p class="caption"><span class="caption-text">Getting Started:</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../getting_started/install.html">Install SystemDS</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../getting_started/simple_examples.html">QuickStart</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">Guides</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../guide/federated.html">Federated Environment</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../guide/algorithms_basics.html">Built-in Algorithms</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">Onnx SystemDS</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../onnx_systemds/onnx_systemds.html">QuickStart Onnx</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../onnx_systemds/onnx_systemds_design.html">Design</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">API</span></p> |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../operator/algorithms.html">Algorithms</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../context/systemds_context.html">SystemDSContext</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="data_gen.html">Data Generators</a></li> |
| <li class="toctree-l1 current"><a class="current reference internal" href="#">Matrix</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="federated.html">Federated</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../operator/operation_node.html">Operation Node</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../onnx_systemds/convert.html">Convert</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../onnx_systemds/onnx_helper.html">Onnx Helper</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../onnx_systemds/operator_gen.html">Operator Gen</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../onnx_systemds/render.html">Render</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../onnx_systemds/util.html">Util</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">Internals API</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../script_building/dag.html">Dag</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../script_building/script.html">Script</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../utils/converters.html">Converters</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../utils/helpers.html">Helpers</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../../index.html">SystemDS</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="../../index.html" class="icon icon-home"></a> »</li> |
| |
| <li>Matrix</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="../../sources/api/matrix/matrix.rst.txt" rel="nofollow"> View page source</a> |
| |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="matrix"> |
| <h1>Matrix<a class="headerlink" href="#matrix" title="Permalink to this headline">¶</a></h1> |
| <p>A <code class="docutils literal notranslate"><span class="pre">Matrix</span></code> is represented either by an <code class="docutils literal notranslate"><span class="pre">OperationNode</span></code>, or the derived class <code class="docutils literal notranslate"><span class="pre">Matrix</span></code>. |
| An Matrix can be recognized it by checking the <code class="docutils literal notranslate"><span class="pre">output_type</span></code> of the object.</p> |
| <p>Matrices are the most fundamental objects SystemDS operates on.</p> |
| <p>Although it is possible to generate matrices with the function calls or object construction specified below, |
| the recommended way is to use the methods defined on <code class="docutils literal notranslate"><span class="pre">SystemDSContext</span></code>.</p> |
| <dl class="py class"> |
| <dt id="systemds.matrix.Matrix"> |
| <em class="property">class </em><code class="sig-prename descclassname">systemds.matrix.</code><code class="sig-name descname">Matrix</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sds_context</span><span class="p">:</span> <span class="n">SystemDSContext</span></em>, <em class="sig-param"><span class="n">mat</span><span class="p">:</span> <span class="n">Union<span class="p">[</span>numpy.array<span class="p">, </span>os.PathLike<span class="p">]</span></span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span><span class="p">:</span> <span class="n">Sequence<span class="p">[</span>Union<span class="p">[</span>DAGNode<span class="p">, </span>str<span class="p">, </span>int<span class="p">, </span>float<span class="p">, </span>bool<span class="p">]</span><span class="p">]</span></span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Dict<span class="p">[</span>str<span class="p">, </span>Union<span class="p">[</span>DAGNode<span class="p">, </span>str<span class="p">, </span>int<span class="p">, </span>float<span class="p">, </span>bool<span class="p">]</span><span class="p">]</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#systemds.matrix.Matrix" title="Permalink to this definition">¶</a></dt> |
| <dd><dl class="py method"> |
| <dt id="systemds.matrix.Matrix.__init__"> |
| <code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sds_context</span><span class="p">:</span> <span class="n">SystemDSContext</span></em>, <em class="sig-param"><span class="n">mat</span><span class="p">:</span> <span class="n">Union<span class="p">[</span>numpy.array<span class="p">, </span>os.PathLike<span class="p">]</span></span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span><span class="p">:</span> <span class="n">Sequence<span class="p">[</span>Union<span class="p">[</span>DAGNode<span class="p">, </span>str<span class="p">, </span>int<span class="p">, </span>float<span class="p">, </span>bool<span class="p">]</span><span class="p">]</span></span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Dict<span class="p">[</span>str<span class="p">, </span>Union<span class="p">[</span>DAGNode<span class="p">, </span>str<span class="p">, </span>int<span class="p">, </span>float<span class="p">, </span>bool<span class="p">]</span><span class="p">]</span></span></em><span class="sig-paren">)</span> → None<a class="headerlink" href="#systemds.matrix.Matrix.__init__" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Generate DAGNode representing matrix with data either given by a numpy array, which will be sent to SystemDS |
| on need, or a path pointing to a matrix.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>mat</strong> – the numpy array or path to matrix file</p></li> |
| <li><p><strong>args</strong> – unnamed parameters</p></li> |
| <li><p><strong>kwargs</strong> – named parameters</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="systemds.matrix.Matrix.cholesky"> |
| <code class="sig-name descname">cholesky</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">safe</span><span class="p">:</span> <span class="n">bool</span> <span class="o">=</span> <span class="default_value">False</span></em><span class="sig-paren">)</span> → systemds.operator.operation_node.OperationNode<a class="headerlink" href="#systemds.matrix.Matrix.cholesky" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Computes the Cholesky decomposition of a symmetric, positive definite matrix</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>safe</strong> – default value is False, if flag is True additional checks to ensure |
| that the matrix is symmetric positive definite are applied, if False, checks will be skipped</p> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p>the OperationNode representing this operation</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="systemds.matrix.Matrix.code_line"> |
| <code class="sig-name descname">code_line</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">var_name</span><span class="p">:</span> <span class="n">str</span></em>, <em class="sig-param"><span class="n">unnamed_input_vars</span><span class="p">:</span> <span class="n">Sequence<span class="p">[</span>str<span class="p">]</span></span></em>, <em class="sig-param"><span class="n">named_input_vars</span><span class="p">:</span> <span class="n">Dict<span class="p">[</span>str<span class="p">, </span>str<span class="p">]</span></span></em><span class="sig-paren">)</span> → str<a class="headerlink" href="#systemds.matrix.Matrix.code_line" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Generates the DML code line equal to the intended action of this node.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>var_name</strong> – Name of DML-variable this nodes result should be saved in</p></li> |
| <li><p><strong>unnamed_input_vars</strong> – all strings representing the unnamed parameters</p></li> |
| <li><p><strong>named_input_vars</strong> – all strings representing the named parameters (name value pairs)</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p>the DML code line that is equal to this operation</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="systemds.matrix.Matrix.compute"> |
| <code class="sig-name descname">compute</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">verbose</span><span class="p">:</span> <span class="n">bool</span> <span class="o">=</span> <span class="default_value">False</span></em>, <em class="sig-param"><span class="n">lineage</span><span class="p">:</span> <span class="n">bool</span> <span class="o">=</span> <span class="default_value">False</span></em><span class="sig-paren">)</span> → numpy.array<a class="headerlink" href="#systemds.matrix.Matrix.compute" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Get result of this operation. Builds the dml script and executes it in SystemDS, before this method is called |
| all operations are only building the DAG without actually executing (lazy evaluation).</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>verbose</strong> – Can be activated to print additional information such as created DML-Script</p></li> |
| <li><p><strong>lineage</strong> – Can be activated to print lineage trace till this node</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p>the output as an python builtin data type or numpy array</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="systemds.matrix.Matrix.order"> |
| <code class="sig-name descname">order</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">by</span><span class="p">:</span> <span class="n">int</span> <span class="o">=</span> <span class="default_value">1</span></em>, <em class="sig-param"><span class="n">decreasing</span><span class="p">:</span> <span class="n">bool</span> <span class="o">=</span> <span class="default_value">False</span></em>, <em class="sig-param"><span class="n">index_return</span><span class="p">:</span> <span class="n">bool</span> <span class="o">=</span> <span class="default_value">False</span></em><span class="sig-paren">)</span> → systemds.operator.operation_node.OperationNode<a class="headerlink" href="#systemds.matrix.Matrix.order" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sort by a column of the matrix X in increasing/decreasing order and returns either the index or data</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>by</strong> – sort matrix by this column number</p></li> |
| <li><p><strong>decreasing</strong> – If true the matrix will be sorted in decreasing order</p></li> |
| <li><p><strong>index_return</strong> – If true, the index numbers will be returned</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p>the OperationNode representing this operation</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="systemds.matrix.Matrix.pass_python_data_to_prepared_script"> |
| <code class="sig-name descname">pass_python_data_to_prepared_script</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sds</span></em>, <em class="sig-param"><span class="n">var_name</span><span class="p">:</span> <span class="n">str</span></em>, <em class="sig-param"><span class="n">prepared_script</span><span class="p">:</span> <span class="n">py4j.java_gateway.JavaObject</span></em><span class="sig-paren">)</span> → None<a class="headerlink" href="#systemds.matrix.Matrix.pass_python_data_to_prepared_script" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Passes data from python to the prepared script object.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>jvm</strong> – the java virtual machine object</p></li> |
| <li><p><strong>var_name</strong> – the variable name the data should get in java</p></li> |
| <li><p><strong>prepared_script</strong> – the prepared script</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="systemds.matrix.Matrix.rev"> |
| <code class="sig-name descname">rev</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → systemds.operator.operation_node.OperationNode<a class="headerlink" href="#systemds.matrix.Matrix.rev" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Reverses the rows in a matrix</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>the OperationNode representing this operation</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="systemds.matrix.Matrix.t"> |
| <code class="sig-name descname">t</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → systemds.operator.operation_node.OperationNode<a class="headerlink" href="#systemds.matrix.Matrix.t" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Transposes the input matrix</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>the OperationNode representing this operation</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="systemds.matrix.Matrix.to_one_hot"> |
| <code class="sig-name descname">to_one_hot</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">num_classes</span><span class="p">:</span> <span class="n">int</span></em><span class="sig-paren">)</span> → systemds.operator.operation_node.OperationNode<a class="headerlink" href="#systemds.matrix.Matrix.to_one_hot" title="Permalink to this definition">¶</a></dt> |
| <dd><p>OneHot encode the matrix.</p> |
| <p>It is assumed that there is only one column to encode, and all values are whole numbers > 0</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>num_classes</strong> – The number of classes to encode into. max value contained in the matrix must be <= num_classes</p> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p>The OperationNode containing the oneHotEncoded values</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="federated.html" class="btn btn-neutral float-right" title="Federated" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="data_gen.html" class="btn btn-neutral float-left" title="Data Generators" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| |
| © Copyright 2020, Apache SystemDS |
| |
| </p> |
| </div> |
| |
| |
| |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a |
| |
| <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> |
| |
| provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
