| |
| |
| <!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>Helpers — 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="prev" title="Converters" href="converters.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> |
| <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="../matrix/matrix.html">Matrix</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../matrix/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 class="current"> |
| <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="converters.html">Converters</a></li> |
| <li class="toctree-l1 current"><a class="current reference internal" href="#">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>Helpers</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="../../sources/api/utils/helpers.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="helpers"> |
| <h1>Helpers<a class="headerlink" href="#helpers" title="Permalink to this headline">¶</a></h1> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>OPS! For internal use!</p> |
| </div> |
| <span class="target" id="module-systemds.utils.helpers"></span><dl class="py function"> |
| <dt id="systemds.utils.helpers.create_params_string"> |
| <code class="sig-prename descclassname">systemds.utils.helpers.</code><code class="sig-name descname">create_params_string</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">unnamed_parameters</span><span class="p">:</span> <span class="n">Iterable<span class="p">[</span>str<span class="p">]</span></span></em>, <em class="sig-param"><span class="n">named_parameters</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.utils.helpers.create_params_string" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Creates a string for providing parameters in dml. Basically converts both named and unnamed parameter |
| to a format which can be used in a dml function call.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>unnamed_parameters</strong> – the unnamed parameter variables</p></li> |
| <li><p><strong>named_parameters</strong> – a dictionary of parameter names and variable names</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p>the string to represent all parameters</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt id="systemds.utils.helpers.get_module_dir"> |
| <code class="sig-prename descclassname">systemds.utils.helpers.</code><code class="sig-name descname">get_module_dir</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → os.PathLike<a class="headerlink" href="#systemds.utils.helpers.get_module_dir" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gives the path to our module</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>path to our module</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| |
| <a href="converters.html" class="btn btn-neutral float-left" title="Converters" 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> |
