trees.Tensor.to.auto.html 31.5 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475


<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  <meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>to &mdash; DI-treetensor 0.3.0 documentation</title>
  

  
  
  
  

  
  <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script>
  
    
      <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 async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
    
    <script type="text/javascript" src="../../_static/js/theme.js"></script>

    

  
  <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="tolist" href="trees.Tensor.tolist.auto.html" />
    <link rel="prev" title="sum" href="trees.Tensor.sum.auto.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"> DI-treetensor
          

          
          </a>

          
            
            
              <div class="version">
                0.3.0
              </div>
            
          

          
<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><span class="caption-text">Tutorials</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/installation/index.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/quick_start/index.html">Quick Start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/plugins/index.html">Plugins</a></li>
</ul>
<p><span class="caption-text">Best Practice</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../best_practice/stack/index.html">Stack Structured Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../best_practice/operation/index.html">Customized Operations For Different Fields</a></li>
</ul>
<p><span class="caption-text">API Documentation</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../common/index.html">treetensor.common</a></li>
<li class="toctree-l1"><a class="reference internal" href="../config/index.html">treetensor.config</a></li>
<li class="toctree-l1"><a class="reference internal" href="../numpy/index.html">treetensor.numpy</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">treetensor.torch</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="funcs.auto.html">Common Functions</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="trees.auto.html">Tree Classes</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="trees.Size.auto.html">Size</a></li>
<li class="toctree-l3 current"><a class="reference internal" href="trees.Tensor.auto.html">Tensor</a><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.__eq__.auto.html">__eq__</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.__ge__.auto.html">__ge__</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.__gt__.auto.html">__gt__</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.__init__.auto.html">__init__</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.__le__.auto.html">__le__</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.__lt__.auto.html">__lt__</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.__ne__.auto.html">__ne__</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor._attr_extern.auto.html">_attr_extern [No Doc]</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.abs.auto.html">abs</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.abs_.auto.html">abs_</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.add.auto.html">add</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.add_.auto.html">add_</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.all.auto.html">all</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.any.auto.html">any</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.ceil.auto.html">ceil</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.ceil_.auto.html">ceil_</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.chunk.auto.html">chunk</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.clamp.auto.html">clamp</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.clamp_.auto.html">clamp_</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.clone.auto.html">clone</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.cpu.auto.html">cpu</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.cuda.auto.html">cuda</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.detach.auto.html">detach</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.detach_.auto.html">detach_</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.dist.auto.html">dist</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.div.auto.html">div</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.div_.auto.html">div_</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.dot.auto.html">dot</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.exp.auto.html">exp</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.exp2.auto.html">exp2</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.exp2_.auto.html">exp2_</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.exp_.auto.html">exp_</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.floor.auto.html">floor</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.floor_.auto.html">floor_</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.grad.auto.html">grad</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.index_select.auto.html">index_select</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.isclose.auto.html">isclose</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.isfinite.auto.html">isfinite</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.isinf.auto.html">isinf</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.isnan.auto.html">isnan</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.log.auto.html">log</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.log10.auto.html">log10</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.log10_.auto.html">log10_</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.log2.auto.html">log2</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.log2_.auto.html">log2_</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.log_.auto.html">log_</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.masked_select.auto.html">masked_select</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.matmul.auto.html">matmul</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.max.auto.html">max</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.mean.auto.html">mean</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.min.auto.html">min</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.mm.auto.html">mm</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.mul.auto.html">mul</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.mul_.auto.html">mul_</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.neg.auto.html">neg</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.neg_.auto.html">neg_</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.norm.auto.html">norm</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.numel.auto.html">numel</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.numpy.auto.html">numpy</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.pow.auto.html">pow</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.pow_.auto.html">pow_</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.requires_grad.auto.html">requires_grad</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.requires_grad_.auto.html">requires_grad_</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.reshape.auto.html">reshape</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.round.auto.html">round</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.round_.auto.html">round_</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.shape.auto.html">shape</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.sigmoid.auto.html">sigmoid</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.sigmoid_.auto.html">sigmoid_</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.sign.auto.html">sign</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.sign_.auto.html">sign_</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.split.auto.html">split</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.sqrt.auto.html">sqrt</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.sqrt_.auto.html">sqrt_</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.squeeze.auto.html">squeeze</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.squeeze_.auto.html">squeeze_</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.std.auto.html">std</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.sub.auto.html">sub</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.sub_.auto.html">sub_</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.sum.auto.html">sum</a></li>
<li class="toctree-l4 current"><a class="current reference internal" href="#">to</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.tolist.auto.html">tolist</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.unsqueeze.auto.html">unsqueeze</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.unsqueeze_.auto.html">unsqueeze_</a></li>
<li class="toctree-l4"><a class="reference internal" href="trees.Tensor.where.auto.html">where</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../utils/index.html">treetensor.utils</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">DI-treetensor</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">Docs</a> &raquo;</li>
        
          <li><a href="index.html">treetensor.torch</a> &raquo;</li>
        
          <li><a href="trees.auto.html">Tree Classes</a> &raquo;</li>
        
          <li><a href="trees.Tensor.auto.html">Tensor</a> &raquo;</li>
        
      <li>to</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="../../_sources/api_doc/torch/trees.Tensor.to.auto.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">
            
    
    
  <section id="to">
<h1>to<a class="headerlink" href="#to" title="Permalink to this headline"></a></h1>
<section id="documentation">
<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="treetensor.torch.Tensor">
<em class="property">class </em><code class="sig-prename descclassname">treetensor.torch.</code><code class="sig-name descname">Tensor</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/treetensor/torch/tensor.html#Tensor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#treetensor.torch.Tensor" title="Permalink to this definition"></a></dt>
<dd><dl class="py method">
<dt id="treetensor.torch.Tensor.to">
<code class="sig-name descname">to</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/treetensor/torch/tensor.html#Tensor.to"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#treetensor.torch.Tensor.to" title="Permalink to this definition"></a></dt>
<dd><p>Turn the original tree tensor to another format.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">torch</span>
<span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">treetensor.torch</span> <span class="k">as</span> <span class="nn">ttorch</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">ttorch</span><span class="o">.</span><span class="n">tensor</span><span class="p">({</span>
<span class="gp">... </span>    <span class="s1">&#39;a&#39;</span><span class="p">:</span> <span class="p">[[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">11</span><span class="p">],</span> <span class="p">[</span><span class="mi">2</span><span class="p">,</span> <span class="mi">22</span><span class="p">],</span> <span class="p">[</span><span class="mi">3</span><span class="p">,</span> <span class="mi">33</span><span class="p">]],</span>
<span class="gp">... </span>    <span class="s1">&#39;b&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;x&#39;</span><span class="p">:</span> <span class="p">[[</span><span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">],</span> <span class="p">[</span><span class="mi">6</span><span class="p">,</span> <span class="mi">7</span><span class="p">]]},</span>
<span class="gp">... </span><span class="p">})</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">pytorch</span><span class="o">.</span><span class="n">float64</span><span class="p">)</span>
<span class="go">&lt;Tensor 0x7ff363bb6518&gt;</span>
<span class="go">├── a --&gt; tensor([[ 1., 11.],</span>
<span class="go">│                 [ 2., 22.],</span>
<span class="go">│                 [ 3., 33.]], dtype=torch.float64)</span>
<span class="go">└── b --&gt; &lt;Tensor 0x7ff363bb6ef0&gt;</span>
<span class="go">    └── x --&gt; tensor([[4., 5.],</span>
<span class="go">                      [6., 7.]], dtype=torch.float64)</span>
</pre></div>
</div>
</dd></dl>

</dd></dl>

<div class="tip admonition">
<p class="admonition-title">Torch Version Related</p>
<p>This documentation is based on
<a class="reference external" href="https://pytorch.org/docs/1.12.1+cu102/tensors.html#torch.Tensor.to">torch.Tensor.to</a>
in <a class="reference external" href="https://pytorch.org/docs/1.12.1+cu102/">torch v1.12.1+cu102</a>.
<strong>Its arguments’ arrangements depend on the version of pytorch you installed</strong>.</p>
<p>If some arguments listed here are not working properly, please check your pytorch’s version
with the following command and find its documentation.</p>
<div class="highlight-shell notranslate"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span>python -c <span class="s1">&#39;import torch;print(torch.__version__)&#39;</span>
</pre></div></td></tr></table></div>
</div>
<p>The arguments and keyword arguments supported in torch v1.12.1+cu102 is listed below.</p>
</div>
</section>
<section id="description-from-torch-v1-12-1-cu102">
<h2>Description From Torch v1.12.1+cu102<a class="headerlink" href="#description-from-torch-v1-12-1-cu102" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="torch.Tensor">
<em class="property">class </em><code class="sig-prename descclassname">torch.</code><code class="sig-name descname">Tensor</code><a class="headerlink" href="#torch.Tensor" title="Permalink to this definition"></a></dt>
<dd><dl class="py method">
<dt id="torch.Tensor.to">
<code class="sig-name descname">to</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span> &#x2192; <a class="reference internal" href="trees.Tensor.where.auto.html#torch.Tensor" title="torch.Tensor">Tensor</a><a class="headerlink" href="#torch.Tensor.to" title="Permalink to this definition"></a></dt>
<dd><p>Performs Tensor dtype and/or device conversion. A <code class="xref py py-class docutils literal notranslate"><span class="pre">torch.dtype</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">torch.device</span></code> are
inferred from the arguments of <code class="docutils literal notranslate"><span class="pre">self.to(*args,</span> <span class="pre">**kwargs)</span></code>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If the <code class="docutils literal notranslate"><span class="pre">self</span></code> Tensor already
has the correct <code class="xref py py-class docutils literal notranslate"><span class="pre">torch.dtype</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">torch.device</span></code>, then <code class="docutils literal notranslate"><span class="pre">self</span></code> is returned.
Otherwise, the returned tensor is a copy of <code class="docutils literal notranslate"><span class="pre">self</span></code> with the desired
<code class="xref py py-class docutils literal notranslate"><span class="pre">torch.dtype</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">torch.device</span></code>.</p>
</div>
<p>Here are the ways to call <code class="docutils literal notranslate"><span class="pre">to</span></code>:</p>
<dl class="py function">
<dt id="id0">
<code class="sig-name descname">to</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">dtype</span></em>, <em class="sig-param"><span class="n">non_blocking</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">copy</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">memory_format</span><span class="o">=</span><span class="default_value">torch.preserve_format</span></em><span class="sig-paren">)</span> &#x2192; <a class="reference internal" href="trees.Tensor.where.auto.html#torch.Tensor" title="torch.Tensor">Tensor</a><a class="headerlink" href="#id0" title="Permalink to this definition"></a></dt>
<dd><p>Returns a Tensor with the specified <code class="xref py py-attr docutils literal notranslate"><span class="pre">dtype</span></code></p>
<dl class="simple">
<dt>Args:</dt><dd><p>memory_format (<code class="xref py py-class docutils literal notranslate"><span class="pre">torch.memory_format</span></code>, optional): the desired memory format of
returned Tensor. Default: <code class="docutils literal notranslate"><span class="pre">torch.preserve_format</span></code>.</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="id1">
<code class="sig-name descname">to</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">device</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">dtype</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">non_blocking</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">copy</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">memory_format</span><span class="o">=</span><span class="default_value">torch.preserve_format</span></em><span class="sig-paren">)</span> &#x2192; <a class="reference internal" href="trees.Tensor.where.auto.html#torch.Tensor" title="torch.Tensor">Tensor</a><a class="headerlink" href="#id1" title="Permalink to this definition"></a></dt>
<dd><p>Returns a Tensor with the specified <code class="xref py py-attr docutils literal notranslate"><span class="pre">device</span></code> and (optional)
<code class="xref py py-attr docutils literal notranslate"><span class="pre">dtype</span></code>. If <code class="xref py py-attr docutils literal notranslate"><span class="pre">dtype</span></code> is <code class="docutils literal notranslate"><span class="pre">None</span></code> it is inferred to be <code class="docutils literal notranslate"><span class="pre">self.dtype</span></code>.
When <code class="xref py py-attr docutils literal notranslate"><span class="pre">non_blocking</span></code>, tries to convert asynchronously with respect to
the host if possible, e.g., converting a CPU Tensor with pinned memory to a
CUDA Tensor.
When <code class="xref py py-attr docutils literal notranslate"><span class="pre">copy</span></code> is set, a new Tensor is created even when the Tensor
already matches the desired conversion.</p>
<dl class="simple">
<dt>Args:</dt><dd><p>memory_format (<code class="xref py py-class docutils literal notranslate"><span class="pre">torch.memory_format</span></code>, optional): the desired memory format of
returned Tensor. Default: <code class="docutils literal notranslate"><span class="pre">torch.preserve_format</span></code>.</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="id2">
<code class="sig-name descname">to</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">other</span></em>, <em class="sig-param"><span class="n">non_blocking</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">copy</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span> &#x2192; <a class="reference internal" href="trees.Tensor.where.auto.html#torch.Tensor" title="torch.Tensor">Tensor</a><a class="headerlink" href="#id2" title="Permalink to this definition"></a></dt>
<dd><p>Returns a Tensor with same <code class="xref py py-class docutils literal notranslate"><span class="pre">torch.dtype</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">torch.device</span></code> as
the Tensor <code class="xref py py-attr docutils literal notranslate"><span class="pre">other</span></code>. When <code class="xref py py-attr docutils literal notranslate"><span class="pre">non_blocking</span></code>, tries to convert
asynchronously with respect to the host if possible, e.g., converting a CPU
Tensor with pinned memory to a CUDA Tensor.
When <code class="xref py py-attr docutils literal notranslate"><span class="pre">copy</span></code> is set, a new Tensor is created even when the Tensor
already matches the desired conversion.</p>
</dd></dl>

<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">tensor</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">randn</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>  <span class="c1"># Initially dtype=float32, device=cpu</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">tensor</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">float64</span><span class="p">)</span>
<span class="go">tensor([[-0.5044,  0.0005],</span>
<span class="go">        [ 0.3310, -0.0584]], dtype=torch.float64)</span>

<span class="gp">&gt;&gt;&gt; </span><span class="n">cuda0</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">device</span><span class="p">(</span><span class="s1">&#39;cuda:0&#39;</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">tensor</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">cuda0</span><span class="p">)</span>
<span class="go">tensor([[-0.5044,  0.0005],</span>
<span class="go">        [ 0.3310, -0.0584]], device=&#39;cuda:0&#39;)</span>

<span class="gp">&gt;&gt;&gt; </span><span class="n">tensor</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">cuda0</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">torch</span><span class="o">.</span><span class="n">float64</span><span class="p">)</span>
<span class="go">tensor([[-0.5044,  0.0005],</span>
<span class="go">        [ 0.3310, -0.0584]], dtype=torch.float64, device=&#39;cuda:0&#39;)</span>

<span class="gp">&gt;&gt;&gt; </span><span class="n">other</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">randn</span><span class="p">((),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">torch</span><span class="o">.</span><span class="n">float64</span><span class="p">,</span> <span class="n">device</span><span class="o">=</span><span class="n">cuda0</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">tensor</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">non_blocking</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="go">tensor([[-0.5044,  0.0005],</span>
<span class="go">        [ 0.3310, -0.0584]], dtype=torch.float64, device=&#39;cuda:0&#39;)</span>
</pre></div>
</div>
</dd></dl>

</dd></dl>

</section>
</section>



           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="trees.Tensor.tolist.auto.html" class="btn btn-neutral float-right" title="tolist" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="trees.Tensor.sum.auto.html" class="btn btn-neutral float-left" title="sum" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2022, HansBug, DI-engine&#39;s Contributors

    </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>
  
    <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
  <span class="rst-current-version" data-toggle="rst-current-version">
    <span class="fa fa-book"> Other Versions</span>
    v: dev/py310
    <span class="fa fa-caret-down"></span>
  </span>
        <div class="rst-other-versions">
                <dl>
                    <dt>Tags</dt>
                        <dd><a href="../../../../v0.2.1/api_doc/torch/trees.Tensor.to.auto.html">v0.2.1</a></dd>
                        <dd><a href="../../../../v0.3.0/api_doc/torch/trees.Tensor.to.auto.html">v0.3.0</a></dd>
                </dl>
                <dl>
                    <dt>Branches</dt>
                        <dd><a href="trees.Tensor.to.auto.html">dev/py310</a></dd>
                        <dd><a href="../../../stream/api_doc/torch/trees.Tensor.to.auto.html">dev/stream</a></dd>
                        <dd><a href="../../../../main/api_doc/torch/trees.Tensor.to.auto.html">main</a></dd>
                        <dd><a href="../../../../run/xdemos/api_doc/torch/trees.Tensor.to.auto.html">run/xdemos</a></dd>
                </dl>
        </div>
    </div>

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>