docs/api/python/api/utils/converters.html - systemds - Git at Google



 <!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>Converters &mdash; 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="Helpers" href="helpers.html" />
     <link rel="prev" title="Script" href="../script_building/script.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">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>
 </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 current"><a class="current reference internal" href="#">Converters</a></li>
 <li class="toctree-l1"><a class="reference internal" href="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> &raquo;</li>

       <li>Converters</li>


       <li class="wy-breadcrumbs-aside">


             <a href="../../sources/api/utils/converters.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="converters">
 <h1>Converters<a class="headerlink" href="#converters" 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.converters"></span><dl class="py function">
 <dt id="systemds.utils.converters.matrix_block_to_numpy">
 <code class="sig-prename descclassname">systemds.utils.converters.</code><code class="sig-name descname">matrix_block_to_numpy</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">jvm</span><span class="p">:</span> <span class="n">py4j.java_gateway.JVMView</span></em>, <em class="sig-param"><span class="n">mb</span><span class="p">:</span> <span class="n">py4j.java_gateway.JavaObject</span></em><span class="sig-paren">)</span><a class="headerlink" href="#systemds.utils.converters.matrix_block_to_numpy" title="Permalink to this definition">¶</a></dt>
 <dd><p>Converts a MatrixBlock object in the JVM to a numpy array.</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 current JVM instance running systemds.</p></li>
 <li><p><strong>mb</strong> – A pointer to the JVM’s MatrixBlock object.</p></li>
 </ul>
 </dd>
 </dl>
 </dd></dl>

 <dl class="py function">
 <dt id="systemds.utils.converters.numpy_to_matrix_block">
 <code class="sig-prename descclassname">systemds.utils.converters.</code><code class="sig-name descname">numpy_to_matrix_block</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sds</span><span class="p">:</span> <span class="n">SystemDSContext</span></em>, <em class="sig-param"><span class="n">np_arr</span><span class="p">:</span> <span class="n">numpy.array</span></em><span class="sig-paren">)</span><a class="headerlink" href="#systemds.utils.converters.numpy_to_matrix_block" title="Permalink to this definition">¶</a></dt>
 <dd><p>Converts a given numpy array, to internal matrix block representation.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>sds</strong> – The current systemds context.</p></li>
 <li><p><strong>np_arr</strong> – the numpy array to convert to matrixblock.</p></li>
 </ul>
 </dd>
 </dl>
 </dd></dl>

 </div>


            </div>

           </div>
           <footer>

     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

         <a href="helpers.html" class="btn btn-neutral float-right" title="Helpers" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


         <a href="../script_building/script.html" class="btn btn-neutral float-left" title="Script" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

     </div>


   <hr/>

   <div role="contentinfo">
     <p>

         &copy; 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>


	<!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>Converters — 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="Helpers" href="helpers.html" />
	<link rel="prev" title="Script" href="../script_building/script.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">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>
	</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 current"><a class="current reference internal" href="#">Converters</a></li>
	<li class="toctree-l1"><a class="reference internal" href="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>Converters</li>


	<li class="wy-breadcrumbs-aside">


	<a href="../../sources/api/utils/converters.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="converters">
	<h1>Converters<a class="headerlink" href="#converters" 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.converters"></span><dl class="py function">
	<dt id="systemds.utils.converters.matrix_block_to_numpy">
	<code class="sig-prename descclassname">systemds.utils.converters.</code><code class="sig-name descname">matrix_block_to_numpy</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">jvm</span><span class="p">:</span> <span class="n">py4j.java_gateway.JVMView</span></em>, <em class="sig-param"><span class="n">mb</span><span class="p">:</span> <span class="n">py4j.java_gateway.JavaObject</span></em><span class="sig-paren">)</span><a class="headerlink" href="#systemds.utils.converters.matrix_block_to_numpy" title="Permalink to this definition">¶</a></dt>
	<dd><p>Converts a MatrixBlock object in the JVM to a numpy array.</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 current JVM instance running systemds.</p></li>
	<li><p><strong>mb</strong> – A pointer to the JVM’s MatrixBlock object.</p></li>
	</ul>
	</dd>
	</dl>
	</dd></dl>

	<dl class="py function">
	<dt id="systemds.utils.converters.numpy_to_matrix_block">
	<code class="sig-prename descclassname">systemds.utils.converters.</code><code class="sig-name descname">numpy_to_matrix_block</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sds</span><span class="p">:</span> <span class="n">SystemDSContext</span></em>, <em class="sig-param"><span class="n">np_arr</span><span class="p">:</span> <span class="n">numpy.array</span></em><span class="sig-paren">)</span><a class="headerlink" href="#systemds.utils.converters.numpy_to_matrix_block" title="Permalink to this definition">¶</a></dt>
	<dd><p>Converts a given numpy array, to internal matrix block representation.</p>
	<dl class="field-list simple">
	<dt class="field-odd">Parameters</dt>
	<dd class="field-odd"><ul class="simple">
	<li><p><strong>sds</strong> – The current systemds context.</p></li>
	<li><p><strong>np_arr</strong> – the numpy array to convert to matrixblock.</p></li>
	</ul>
	</dd>
	</dl>
	</dd></dl>

	</div>


	</div>

	</div>
	<footer>

	<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

	<a href="helpers.html" class="btn btn-neutral float-right" title="Helpers" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


	<a href="../script_building/script.html" class="btn btn-neutral float-left" title="Script" 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>