Skip to content

D
DI-treetensor

OpenDILab开源决策智能平台 / DI-treetensor
大约 1 年 前同步成功

通知 48
Star 172
Fork 11
D
DI-treetensor

体验新版 GitCode，发现更多精彩内容 >>

切换分支/标签
查找文件 普通视图历史永久链接Permalink
object.html 15.7 KB
Newer Older
HansBug's avatar
Deploying to gh-pages from @ ee3540881debe9223c67ef56b808636a690de412 🚀  
HansBug 已提交
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 


<!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>treetensor.common.object &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="treetensor.common.trees" href="trees.html" />
    <link rel="prev" title="treetensor.common" href="index.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 current"><a class="reference internal" href="index.html">treetensor.common</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">treetensor.common.object</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#object">Object</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="trees.html">treetensor.common.trees</a></li>
<li class="toctree-l2"><a class="reference internal" href="wrappers.html">treetensor.common.wrappers</a></li>
</ul>
</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"><a class="reference internal" href="../torch/index.html">treetensor.torch</a></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.common</a> &raquo;</li>
        
      <li>treetensor.common.object</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="../../_sources/api_doc/common/object.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="treetensor-common-object">
<h1>treetensor.common.object<a class="headerlink" href="#treetensor-common-object" title="Permalink to this headline"></a></h1>
<section id="object">
<h2>Object<a class="headerlink" href="#object" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="treetensor.common.Object">
<em class="property">class </em><code class="sig-prename descclassname">treetensor.common.</code><code class="sig-name descname">Object</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/common/object.html#Object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#treetensor.common.Object" title="Permalink to this definition"></a></dt>
<dd><dl class="simple">
<dt>Overview:</dt><dd><p>Generic object tree class, used in <a class="reference internal" href="../numpy/index.html#module-treetensor.numpy" title="treetensor.numpy"><code class="xref py py-mod docutils literal notranslate"><span class="pre">treetensor.numpy</span></code></a> and <a class="reference internal" href="../torch/index.html#module-treetensor.torch" title="treetensor.torch"><code class="xref py py-mod docutils literal notranslate"><span class="pre">treetensor.torch</span></code></a>.</p>
</dd>
</dl>
<dl class="py method">
<dt id="treetensor.common.Object.__init__">
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/treetensor/common/object.html#Object.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#treetensor.common.Object.__init__" title="Permalink to this definition"></a></dt>
<dd><p>In <a class="reference internal" href="#treetensor.common.Object" title="treetensor.common.Object"><code class="xref py py-class docutils literal notranslate"><span class="pre">treetensor.common.Object</span></code></a>, object or object tree can be initialized.</p>
<p>Examples:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">treetensor.common</span> <span class="kn">import</span> <span class="n">Object</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">Object</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="go">1</span>

<span class="gp">&gt;&gt;&gt; </span><span class="n">Object</span><span class="p">({</span><span class="s1">&#39;a&#39;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s1">&#39;b&#39;</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="s1">&#39;x&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;c&#39;</span><span class="p">:</span> <span class="mi">233</span><span class="p">}})</span>
<span class="go">&lt;Object 0x7fe00b1153a0&gt;</span>
<span class="go">├── a --&gt; 1</span>
<span class="go">├── b --&gt; 2</span>
<span class="go">└── x --&gt; &lt;Object 0x7fe00b115ee0&gt;</span>
<span class="go">    └── c --&gt; 233</span>
</pre></div>
</div>
</dd></dl>

<dl class="py method">
<dt id="treetensor.common.Object.all">
<code class="sig-name descname">all</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/treetensor/common/object.html#Object.all"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#treetensor.common.Object.all" title="Permalink to this definition"></a></dt>
<dd><p>The values in this tree is all true or not.</p>
<p>Examples:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">treetensor.common</span> <span class="kn">import</span> <span class="n">Object</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">Object</span><span class="p">({</span><span class="s1">&#39;a&#39;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</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="kc">False</span><span class="p">}})</span><span class="o">.</span><span class="n">all</span><span class="p">()</span>
<span class="go">False</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">Object</span><span class="p">({</span><span class="s1">&#39;a&#39;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</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="kc">False</span><span class="p">}})</span><span class="o">.</span><span class="n">all</span><span class="p">()</span>
<span class="go">False</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">Object</span><span class="p">({</span><span class="s1">&#39;a&#39;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</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="kc">True</span><span class="p">}})</span><span class="o">.</span><span class="n">all</span><span class="p">()</span>
<span class="go">True</span>
</pre></div>
</div>
</dd></dl>

<dl class="py method">
<dt id="treetensor.common.Object.any">
<code class="sig-name descname">any</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/treetensor/common/object.html#Object.any"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#treetensor.common.Object.any" title="Permalink to this definition"></a></dt>
<dd><p>The values in this tree is not all False or yes.</p>
<p>Examples:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">treetensor.common</span> <span class="kn">import</span> <span class="n">Object</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">Object</span><span class="p">({</span><span class="s1">&#39;a&#39;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</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="kc">False</span><span class="p">}})</span><span class="o">.</span><span class="n">any</span><span class="p">()</span>
<span class="go">False</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">Object</span><span class="p">({</span><span class="s1">&#39;a&#39;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</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="kc">False</span><span class="p">}})</span><span class="o">.</span><span class="n">any</span><span class="p">()</span>
<span class="go">True</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">Object</span><span class="p">({</span><span class="s1">&#39;a&#39;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</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="kc">True</span><span class="p">}})</span><span class="o">.</span><span class="n">any</span><span class="p">()</span>
<span class="go">True</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.html" class="btn btn-neutral float-right" title="treetensor.common.trees" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="index.html" class="btn btn-neutral float-left" title="treetensor.common" 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/stream
    <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/common/object.html">v0.2.1</a></dd>
                        <dd><a href="../../../../v0.3.0/api_doc/common/object.html">v0.3.0</a></dd>
                </dl>
                <dl>
                    <dt>Branches</dt>
HansBug's avatar
Deploying to gh-pages from @ 3107ba0426ae7652c129ce85ff0b5d897deb9acd 🚀  
HansBug 已提交
301 
                        <dd><a href="../../../py310/api_doc/common/object.html">dev/py310</a></dd>
HansBug's avatar
Deploying to gh-pages from @ 6446730f1a4ce35b190cc66938c78f4e2eccafe3 🚀  
HansBug 已提交
302 
                        <dd><a href="object.html">dev/stream</a></dd>
HansBug's avatar
Deploying to gh-pages from @ 3107ba0426ae7652c129ce85ff0b5d897deb9acd 🚀  
HansBug 已提交
303 
                        <dd><a href="../../../../main/api_doc/common/object.html">main</a></dd>
HansBug's avatar
Deploying to gh-pages from @ ee3540881debe9223c67ef56b808636a690de412 🚀  
HansBug 已提交
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 
                        <dd><a href="../../../../run/xdemos/api_doc/common/object.html">run/xdemos</a></dd>
                </dl>
        </div>
    </div>

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

  
  
    
   

</body>
</html>