Inicio Explorar Axuda
Iniciar sesión
rparedis
/
pyCBD
Seguir 1
Destacar 0
Fork 0
Ficheiros Incidencias 27 Pull Requests 0 Wiki
Árbore: 865371f86c
Ramas Etiquetas
pyCBD
/
doc
/
_build
/
html
/
_modules
/
CBD
/
lib
/
endpoints.html

endpoints.html 43 KB
Histórico Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623 
  1. 

  2. 

  3. 

  4. <!DOCTYPE html>
    5. 

  5. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
    6. 

  6. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
    7. 

  7. <head>
    8. 

  8.   <meta charset="utf-8">
    9. 

  9.   
    10. 

  10.   <meta name="viewport" content="width=device-width, initial-scale=1.0">
    11. 

  11.   
    12. 

  12.   <title>CBD.lib.endpoints &mdash; CBD Simulation Development Kit  documentation</title>
    13. 

  13.   
    14. 

  14. 

  15.   
    16. 

  16.   
    17. 

  17.   
    18. 

  18.   
    19. 

  19. 

  20.   
    21. 

  21. 

  22.   
    23. 

  23.   
    24. 

  24.     
    25. 

  25. 

  26.   
    27. 

  27. 

  28.   <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
    29. 

  29.   <!-- <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> -->
    30. 

  30.   <link rel="stylesheet" href="../../../_static/style.css" type="text/css" />
    31. 

  31.     <link rel="index" title="Index" href="../../../genindex.html" />
    32. 

  32.     <link rel="search" title="Search" href="../../../search.html" /> 
    33. 

  33. 

  34.   
    35. 

  35.   <script async src="https://www.googletagmanager.com/gtag/js?id=UA-167094275-1"></script>
    36. 

  36.   <script src="../../../_static/js/googleanalytics.min.js"></script>
    37. 

  37.   
    38. 

  38.   <script src="../../../_static/js/modernizr.min.js"></script>
    39. 

  39. 

  40.   <!-- Preload the theme fonts -->
    41. 

  41. 

  42. <link rel="preload" href="../../../_static/fonts/FreightSans/freight-sans-book.woff2" as="font" type="font/woff2" crossorigin="anonymous">
    43. 

  43. <link rel="preload" href="../../../_static/fonts/FreightSans/freight-sans-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
    44. 

  44. <link rel="preload" href="../../../_static/fonts/IBMPlexMono/IBMPlexMono-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
    45. 

  45. <link rel="preload" href="../../../_static/fonts/FreightSans/freight-sans-bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
    46. 

  46. <link rel="preload" href="../../../_static/fonts/FreightSans/freight-sans-medium-italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
    47. 

  47. <link rel="preload" href="../../../_static/fonts/IBMPlexMono/IBMPlexMono-SemiBold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
    48. 

  48. 

  49. <!-- Preload the katex fonts -->
    50. 

  50. 

  51. <link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Math-Italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
    52. 

  52. <link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Main-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
    53. 

  53. <link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Main-Bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
    54. 

  54. <link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size1-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
    55. 

  55. <link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size4-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
    56. 

  56. <link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size2-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
    57. 

  57. <link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size3-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
    58. 

  58. <link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Caligraphic-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
    59. 

  59. </head>
    60. 

  60. 

  61. <div class="container-fluid header-holder tutorials-header" id="header-holder">
    62. 

  62.   <div class="container">
    63. 

  63.     <div class="header-container">
    64. 

  64.       <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
    65. 

  65. 

  66.       <div class="main-menu">
    67. 

  67.         <ul>
    68. 

  68. 

  69.           <li>
    70. 

  70.             <div class="ecosystem-dropdown">
    71. 

  71.               <a id="dropdownMenuButtonEcosystem" data-toggle="ecosystem-dropdown">
    72. 

  72.                 Ecosystem
    73. 

  73.               </a>
    74. 

  74.               <div class="ecosystem-dropdown-menu">
    75. 

  75.                 <a class="nav-dropdown-item" href="https://alchemy.host">
    76. 

  76.                   <span class=dropdown-title>Alchemy</span>
    77. 

  77.                   <p>Experiments logging & visualization</p>
    78. 

  78.                 </a>
    79. 

  79.                 <a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">
    80. 

  80.                   <span class=dropdown-title>Catalyst</span>
    81. 

  81.                   <p>Accelerated deep learning R&D</p>
    82. 

  82.                 </a>
    83. 

  83.                 <a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">
    84. 

  84.                   <span class=dropdown-title>Reaction</span>
    85. 

  85.                   <p>Convenient deep learning models serving</p>
    86. 

  86.                 </a>
    87. 

  87.               </div>
    88. 

  88.             </div>
    89. 

  89.           </li>
    90. 

  90. 

  91.           <li>
    92. 

  92.             <div class="projects-dropdown">
    93. 

  93.               <a id="dropdownMenuButtonProjects" data-toggle="projects-dropdown">
    94. 

  94.                 Projects
    95. 

  95.               </a>
    96. 

  96.               <div class="projects-dropdown-menu">
    97. 

  97.                 <a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">
    98. 

  98.                   <span class=dropdown-title>Codestyle</span>
    99. 

  99.                   <p>Joint R&D codestyle</p>
    100. 

  100.                 </a>
    101. 

  101.                 <a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">
    102. 

  102.                   <span class=dropdown-title>Catalyst.Neuro</span>
    103. 

  103.                   <p>Catalyst.Team and TReNDS collaborative project</p>
    104. 

  104.                 </a>
    105. 

  105.                 <a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">
    106. 

  106.                   <span class=dropdown-title>Classification</span>
    107. 

  107.                   <p>Image classification pipeline with transfer learning</p>
    108. 

  108.                 </a>
    109. 

  109.                 <a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">
    110. 

  110.                   <span class=dropdown-title>Detection</span>
    111. 

  111.                   <p>Object detection pipeline</p>
    112. 

  112.                 </a>
    113. 

  113.                 <a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">
    114. 

  114.                   <span class=dropdown-title>Segmentation</span>
    115. 

  115.                   <p>Image semantic segmentation pipeline</p>
    116. 

  116.                 </a>
    117. 

  117.                 <a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">
    118. 

  118.                   <span class=dropdown-title>Catalyst.GAN</span>
    119. 

  119.                   <p>GAN pipelines</p>
    120. 

  120.                 </a>
    121. 

  121.               </div>
    122. 

  122.             </div>
    123. 

  123.           </li>
    124. 

  124. 

  125.           <li>
    126. 

  126.             <a href="https://github.com/catalyst-team/dl-course">Deep learning course</a>
    127. 

  127.           </li>
    128. 

  128.         </ul>
    129. 

  129.       </div>
    130. 

  130. 

  131.       <a class="main-menu-open-button" href="#" data-behavior="open-mobile-menu"></a>
    132. 

  132.     </div>
    133. 

  133. 

  134.   </div>
    135. 

  135. </div>
    136. 

  136. 

  137. 

  138. <body class="catalyst-body">
    139. 

  139. 

  140.    
    141. 

  141. 

  142.     
    143. 

  143. 

  144.     <div class="table-of-contents-link-wrapper">
    145. 

  145.       <span>Table of Contents</span>
    146. 

  146.       <a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>
    147. 

  147.     </div>
    148. 

  148. 

  149.     <nav data-toggle="wy-nav-shift" class="catalyst-left-menu" id="catalyst-left-menu">
    150. 

  150.       <div class="catalyst-side-scroll">
    151. 

  151.         <div class="catalyst-menu catalyst-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
    152. 

  152.           <div class="catalyst-left-menu-search">
    153. 

  153.             
    154. 

  154. 

  155.             
    156. 

  156.               
    157. 

  157.               
    158. 

  158.             
    159. 

  159. 

  160.             
    161. 

  161. 

  162. 

  163.   
    164. 

  164. 

  165. 

  166. <div role="search">
    167. 

  167.   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
    168. 

  168.     <input type="text" name="q" placeholder="Search Docs" />
    169. 

  169.     <input type="hidden" name="check_keywords" value="yes" />
    170. 

  170.     <input type="hidden" name="area" value="default" />
    171. 

  171.   </form>
    172. 

  172. </div>
    173. 

  173. 

  174.             
    175. 

  175.           </div>
    176. 

  176. 

  177.           
    178. 

  178.             
    179. 

  179.             
    180. 

  180.               
    181. 

  181.             
    182. 

  182.             
    183. 

  183.               <p class="caption"><span class="caption-text">Setup</span></p>
    184. 

  184. <ul>
    185. 

  185. <li class="toctree-l1"><a class="reference internal" href="../../../install.html">How to install the CBD framework?</a></li>
    186. 

  186. <li class="toctree-l1"><a class="reference internal" href="../../../running.html">How to run a CBD simulation?</a></li>
    187. 

  187. <li class="toctree-l1"><a class="reference internal" href="../../../changelog.html">Changelog</a></li>
    188. 

  188. </ul>
    189. 

  189. <p class="caption"><span class="caption-text">Simple Examples</span></p>
    190. 

  190. <ul>
    191. 

  191. <li class="toctree-l1"><a class="reference internal" href="../../../examples/SinGen.html">Sine Generator</a></li>
    192. 

  192. <li class="toctree-l1"><a class="reference internal" href="../../../examples/EvenNumberGen.html">Hierarchical Even Number Generator</a></li>
    193. 

  193. <li class="toctree-l1"><a class="reference internal" href="../../../examples/Fibonacci.html">Fibonacci Sequence Generator</a></li>
    194. 

  194. <li class="toctree-l1"><a class="reference internal" href="../../../examples/LCG.html">Linear Congruential Generator</a></li>
    195. 

  195. </ul>
    196. 

  196. <p class="caption"><span class="caption-text">Advanced Examples</span></p>
    197. 

  197. <ul>
    198. 

  198. <li class="toctree-l1"><a class="reference internal" href="../../../examples/RealTime.html">Realtime Simulation</a></li>
    199. 

  199. <li class="toctree-l1"><a class="reference internal" href="../../../examples/LivePlot.html">Live Plotting of Data During the Simulation</a></li>
    200. 

  200. </ul>
    201. 

  201. <p class="caption"><span class="caption-text">Internal Documentation</span></p>
    202. 

  202. <ul>
    203. 

  203. <li class="toctree-l1"><a class="reference internal" href="../../../CBD.html">CBD package</a></li>
    204. 

  204. </ul>
    205. 

  205. 

  206.             
    207. 

  207.           
    208. 

  208.         </div>
    209. 

  209.       </div>
    210. 

  210.     </nav>
    211. 

  211. 

  212.     <div class="catalyst-container">
    213. 

  213.       <div class="catalyst-page-level-bar" id="catalyst-page-level-bar">
    214. 

  214.         <div class="catalyst-breadcrumbs-wrapper">
    215. 

  215.           
    216. 

  216. 

  217. 

  218. 

  219. 

  220. 

  221. 

  222. 

  223. 

  224. 

  225. 

  226. 

  227. 

  228. 

  229. 

  230. 

  231. <div role="navigation" aria-label="breadcrumbs navigation">
    232. 

  232. 

  233.   <ul class="catalyst-breadcrumbs">
    234. 

  234.     
    235. 

  235.       <li>
    236. 

  236.         <a href="../../../index.html">
    237. 

  237.           
    238. 

  238.             Docs
    239. 

  239.           
    240. 

  240.         </a> &gt;
    241. 

  241.       </li>
    242. 

  242. 

  243.         
    244. 

  244.           <li><a href="../../index.html">Module code</a> &gt;</li>
    245. 

  245.         
    246. 

  246.       <li>CBD.lib.endpoints</li>
    247. 

  247.     
    248. 

  248.     
    249. 

  249.       <li class="catalyst-breadcrumbs-aside">
    250. 

  250.         
    251. 

  251.       </li>
    252. 

  252.     
    253. 

  253.   </ul>
    254. 

  254. 

  255.   
    256. 

  256. </div>
    257. 

  257.         </div>
    258. 

  258. 

  259.         <div class="catalyst-shortcuts-wrapper" id="catalyst-shortcuts-wrapper">
    260. 

  260.           Shortcuts
    261. 

  261.         </div>
    262. 

  262.       </div>
    263. 

  263. 

  264.       <section data-toggle="wy-nav-shift" id="catalyst-content-wrap" class="catalyst-content-wrap">
    265. 

  265.         <div class="catalyst-content-left">
    266. 

  266.           
    267. 

  267.           <div class="rst-content">
    268. 

  268.           
    269. 

  269.             <div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
    270. 

  270.              <article itemprop="articleBody" id="catalyst-article" class="catalyst-article">
    271. 

  271.               
    272. 

  272.   <h1>Source code for CBD.lib.endpoints</h1><div class="highlight"><pre>
    273. 

  273. <span></span><span class="kn">from</span> <span class="nn">CBD.CBD</span> <span class="kn">import</span> <span class="n">BaseBlock</span>
    274. 

  274. 

  275. 

  276. <div class="viewcode-block" id="CollectorBlock"><a class="viewcode-back" href="../../../CBD.lib.endpoints.html#CBD.lib.endpoints.CollectorBlock">[docs]</a><span class="k">class</span> <span class="nc">CollectorBlock</span><span class="p">(</span><span class="n">BaseBlock</span><span class="p">):</span>
    277. 

  277. 	<span class="sd">&quot;&quot;&quot;</span>
    278. 

  278. <span class="sd">	Abstract class, representing a basic collection unit.</span>
    279. 

  279. <span class="sd">	In the data attribute, a set of values is stored for</span>
    280. 

  280. <span class="sd">	external access (possibly during the simulation).</span>
    281. 

  281. <span class="sd">	This should allow for live plots w.r.t. an independent</span>
    282. 

  282. <span class="sd">	plotting framework.</span>
    283. 

  283. <span class="sd">	&quot;&quot;&quot;</span>
    284. 

  284. 	<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">input_ports</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    285. 

  285. 		<span class="n">BaseBlock</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">input_ports</span><span class="p">,</span> <span class="p">[])</span>
    286. 

  286. 		<span class="bp">self</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">data</span>
    287. 

  287. 

  288. <div class="viewcode-block" id="CollectorBlock.compute"><a class="viewcode-back" href="../../../CBD.lib.endpoints.html#CBD.lib.endpoints.CollectorBlock.compute">[docs]</a>	<span class="k">def</span> <span class="nf">compute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">curIteration</span><span class="p">):</span>
    289. 

  289. 		<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    290. 

  290. 

  291. <div class="viewcode-block" id="CollectorBlock.clear"><a class="viewcode-back" href="../../../CBD.lib.endpoints.html#CBD.lib.endpoints.CollectorBlock.clear">[docs]</a>	<span class="k">def</span> <span class="nf">clear</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    292. 

  292. 		<span class="sd">&quot;&quot;&quot;</span>
    293. 

  293. <span class="sd">		Clears the contents of the block. Must be called in-between</span>
    294. 

  294. <span class="sd">		simulations if the obtainable statistics do not need to</span>
    295. 

  295. <span class="sd">		interfere/retain information about previous simulations.</span>
    296. 

  296. <span class="sd">		&quot;&quot;&quot;</span>
    297. 

  297. 		<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
    298. 

  298. 

  299. 

  300. <div class="viewcode-block" id="SignalCollectorBlock"><a class="viewcode-back" href="../../../CBD.lib.endpoints.html#CBD.lib.endpoints.SignalCollectorBlock">[docs]</a><span class="k">class</span> <span class="nc">SignalCollectorBlock</span><span class="p">(</span><span class="n">CollectorBlock</span><span class="p">):</span>
    301. 

  301. 	<span class="sd">&quot;&quot;&quot;</span>
    302. 

  302. <span class="sd">	Collects a single signal to store w.r.t. the arrival time.</span>
    303. 

  303. <span class="sd">	&quot;&quot;&quot;</span>
    304. 

  304. 	<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
    305. 

  305. 		<span class="n">CollectorBlock</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="p">[</span><span class="s2">&quot;IN1&quot;</span><span class="p">],</span> <span class="p">[])</span>
    306. 

  306. 

  307. <div class="viewcode-block" id="SignalCollectorBlock.compute"><a class="viewcode-back" href="../../../CBD.lib.endpoints.html#CBD.lib.endpoints.SignalCollectorBlock.compute">[docs]</a>	<span class="k">def</span> <span class="nf">compute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">curIteration</span><span class="p">):</span>
    308. 

  308. 		<span class="n">time</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getClock</span><span class="p">()</span><span class="o">.</span><span class="n">getTime</span><span class="p">()</span>
    309. 

  309. 		<span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getInputSignal</span><span class="p">(</span><span class="n">curIteration</span><span class="p">,</span> <span class="s2">&quot;IN1&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">value</span>
    310. 

  310. 		<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">time</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span></div>
    311. 

  311. 

  312. <div class="viewcode-block" id="SignalCollectorBlock.clear"><a class="viewcode-back" href="../../../CBD.lib.endpoints.html#CBD.lib.endpoints.SignalCollectorBlock.clear">[docs]</a>	<span class="k">def</span> <span class="nf">clear</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    313. 

  313. 		<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">clear</span><span class="p">()</span></div>
    314. 

  314. 

  315. 	<span class="nd">@property</span>
    316. 

  316. 	<span class="k">def</span> <span class="nf">data_xy</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    317. 

  317. 		<span class="sd">&quot;&quot;&quot;</span>
    318. 

  318. <span class="sd">		The collected data, as a pair of lists; i.e. the unzipped form of</span>
    319. 

  319. <span class="sd">		:code:`xs, ys`.</span>
    320. 

  320. <span class="sd">		&quot;&quot;&quot;</span>
    321. 

  321. 		<span class="n">D</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[:]</span>
    322. 

  322. 		<span class="k">return</span> <span class="p">[</span><span class="n">x</span> <span class="k">for</span> <span class="n">x</span><span class="p">,</span> <span class="n">_</span> <span class="ow">in</span> <span class="n">D</span><span class="p">],</span> <span class="p">[</span><span class="n">y</span> <span class="k">for</span> <span class="n">_</span><span class="p">,</span> <span class="n">y</span> <span class="ow">in</span> <span class="n">D</span><span class="p">]</span></div>
    323. 

  323. 

  324. 

  325. <div class="viewcode-block" id="PositionCollectorBlock"><a class="viewcode-back" href="../../../CBD.lib.endpoints.html#CBD.lib.endpoints.PositionCollectorBlock">[docs]</a><span class="k">class</span> <span class="nc">PositionCollectorBlock</span><span class="p">(</span><span class="n">CollectorBlock</span><span class="p">):</span>
    326. 

  326. 	<span class="sd">&quot;&quot;&quot;</span>
    327. 

  327. <span class="sd">	Collects a X/Y position.</span>
    328. 

  328. <span class="sd">	&quot;&quot;&quot;</span>
    329. 

  329. 	<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
    330. 

  330. 		<span class="n">CollectorBlock</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="p">[</span><span class="s2">&quot;X&quot;</span><span class="p">,</span> <span class="s2">&quot;Y&quot;</span><span class="p">],</span> <span class="p">[])</span>
    331. 

  331. 		<span class="bp">self</span><span class="o">.</span><span class="n">distance_travelled</span> <span class="o">=</span> <span class="mf">0.0</span>
    332. 

  332. 

  333. <div class="viewcode-block" id="PositionCollectorBlock.compute"><a class="viewcode-back" href="../../../CBD.lib.endpoints.html#CBD.lib.endpoints.PositionCollectorBlock.compute">[docs]</a>	<span class="k">def</span> <span class="nf">compute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">curIteration</span><span class="p">):</span>
    334. 

  334. 		<span class="n">x</span><span class="p">,</span> <span class="n">y</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getInputSignal</span><span class="p">(</span><span class="n">curIteration</span><span class="p">,</span> <span class="s2">&quot;X&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">value</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">getInputSignal</span><span class="p">(</span><span class="n">curIteration</span><span class="p">,</span> <span class="s2">&quot;Y&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">value</span>
    335. 

  335. 		<span class="bp">self</span><span class="o">.</span><span class="n">distance_travelled</span> <span class="o">+=</span> <span class="bp">self</span><span class="o">.</span><span class="n">distance_from_last</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">)</span>
    336. 

  336. 		<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">))</span></div>
    337. 

  337. 

  338. <div class="viewcode-block" id="PositionCollectorBlock.clear"><a class="viewcode-back" href="../../../CBD.lib.endpoints.html#CBD.lib.endpoints.PositionCollectorBlock.clear">[docs]</a>	<span class="k">def</span> <span class="nf">clear</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    339. 

  339. 		<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">clear</span><span class="p">()</span></div>
    340. 

  340. 

  341. <div class="viewcode-block" id="PositionCollectorBlock.distance_from_last"><a class="viewcode-back" href="../../../CBD.lib.endpoints.html#CBD.lib.endpoints.PositionCollectorBlock.distance_from_last">[docs]</a>	<span class="k">def</span> <span class="nf">distance_from_last</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x1</span><span class="p">,</span> <span class="n">y1</span><span class="p">):</span>
    342. 

  342. 		<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
    343. 

  343. 			<span class="k">return</span> <span class="mf">0.0</span>
    344. 

  344. 		<span class="n">x2</span><span class="p">,</span> <span class="n">y2</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
    345. 

  345. 

  346. 		<span class="k">return</span> <span class="p">((</span><span class="n">x2</span> <span class="o">-</span> <span class="n">x1</span><span class="p">)</span> <span class="o">**</span> <span class="mi">2</span> <span class="o">+</span> <span class="p">(</span><span class="n">y2</span> <span class="o">-</span> <span class="n">y1</span><span class="p">)</span> <span class="o">**</span> <span class="mi">2</span><span class="p">)</span> <span class="o">**</span> <span class="mf">0.5</span></div>
    347. 

  347. 

  348. <div class="viewcode-block" id="PositionCollectorBlock.distance_from_start"><a class="viewcode-back" href="../../../CBD.lib.endpoints.html#CBD.lib.endpoints.PositionCollectorBlock.distance_from_start">[docs]</a>	<span class="k">def</span> <span class="nf">distance_from_start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    349. 

  349. 		<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">2</span><span class="p">:</span>
    350. 

  350. 			<span class="k">return</span> <span class="mf">0.0</span>
    351. 

  351. 		<span class="n">x1</span><span class="p">,</span> <span class="n">y1</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
    352. 

  352. 		<span class="n">x2</span><span class="p">,</span> <span class="n">y2</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
    353. 

  353. 

  354. 		<span class="k">return</span> <span class="p">((</span><span class="n">x2</span> <span class="o">-</span> <span class="n">x1</span><span class="p">)</span> <span class="o">**</span> <span class="mi">2</span> <span class="o">+</span> <span class="p">(</span><span class="n">y2</span> <span class="o">-</span> <span class="n">y1</span><span class="p">)</span> <span class="o">**</span> <span class="mi">2</span><span class="p">)</span> <span class="o">**</span> <span class="mf">0.5</span></div>
    355. 

  355. 

  356. 

  357. 	<span class="nd">@property</span>
    358. 

  358. 	<span class="k">def</span> <span class="nf">data_xy</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    359. 

  359. 		<span class="sd">&quot;&quot;&quot;</span>
    360. 

  360. <span class="sd">		The collected data, as a pair of lists; i.e. the unzipped form of</span>
    361. 

  361. <span class="sd">		:code:`xs, ys`.</span>
    362. 

  362. <span class="sd">		&quot;&quot;&quot;</span>
    363. 

  363. 		<span class="n">D</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[:]</span>
    364. 

  364. 		<span class="k">return</span> <span class="p">[</span><span class="n">x</span> <span class="k">for</span> <span class="n">x</span><span class="p">,</span> <span class="n">_</span> <span class="ow">in</span> <span class="n">D</span><span class="p">],</span> <span class="p">[</span><span class="n">y</span> <span class="k">for</span> <span class="n">_</span><span class="p">,</span> <span class="n">y</span> <span class="ow">in</span> <span class="n">D</span><span class="p">]</span></div>
    365. 

  365. 

  366. 

  367. <div class="viewcode-block" id="StatisticsCollectorBlock"><a class="viewcode-back" href="../../../CBD.lib.endpoints.html#CBD.lib.endpoints.StatisticsCollectorBlock">[docs]</a><span class="k">class</span> <span class="nc">StatisticsCollectorBlock</span><span class="p">(</span><span class="n">CollectorBlock</span><span class="p">):</span>
    368. 

  368. 	<span class="sd">&quot;&quot;&quot;</span>
    369. 

  369. <span class="sd">	Collects all inputs and allows for statistical data summaries.</span>
    370. 

  370. 

  371. <span class="sd">	While this can be done on the :class:`SignalCollectorBlock`,</span>
    372. 

  372. <span class="sd">	this class uses a less memory-intensive algorithm to do so.</span>
    373. 

  373. <span class="sd">	When only statistical info is required and a lot of data needs to</span>
    374. 

  374. <span class="sd">	be analyzed, this algorithm should be used!</span>
    375. 

  375. 

  376. <span class="sd">	Note:</span>
    377. 

  377. <span class="sd">		This block only works for **NUMERICAL** data.</span>
    378. 

  378. <span class="sd">	&quot;&quot;&quot;</span>
    379. 

  379. 	<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
    380. 

  380. 		<span class="n">CollectorBlock</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="p">[</span><span class="s2">&quot;IN1&quot;</span><span class="p">],</span> <span class="p">{})</span>
    381. 

  381. 		<span class="bp">self</span><span class="o">.</span><span class="n">clear</span><span class="p">()</span>
    382. 

  382. 

  383. <div class="viewcode-block" id="StatisticsCollectorBlock.compute"><a class="viewcode-back" href="../../../CBD.lib.endpoints.html#CBD.lib.endpoints.StatisticsCollectorBlock.compute">[docs]</a>	<span class="k">def</span> <span class="nf">compute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">curIteration</span><span class="p">):</span>
    384. 

  384. 		<span class="n">data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getInputSignal</span><span class="p">(</span><span class="n">curIteration</span><span class="p">,</span> <span class="s2">&quot;IN1&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">value</span>
    385. 

  385. 		<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;count&quot;</span><span class="p">]</span> <span class="o">+=</span> <span class="mi">1</span>
    386. 

  386. 		<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;sum&quot;</span><span class="p">]</span> <span class="o">+=</span> <span class="n">data</span>
    387. 

  387. 		<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;sumOfSquares&quot;</span><span class="p">]</span> <span class="o">+=</span> <span class="n">data</span> <span class="o">**</span> <span class="mf">2.0</span>
    388. 

  388. 		<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;min&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;min&quot;</span><span class="p">],</span> <span class="n">data</span><span class="p">)</span>
    389. 

  389. 		<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;max&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;max&quot;</span><span class="p">],</span> <span class="n">data</span><span class="p">)</span></div>
    390. 

  390. 

  391. <div class="viewcode-block" id="StatisticsCollectorBlock.clear"><a class="viewcode-back" href="../../../CBD.lib.endpoints.html#CBD.lib.endpoints.StatisticsCollectorBlock.clear">[docs]</a>	<span class="k">def</span> <span class="nf">clear</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    392. 

  392. 		<span class="sd">&quot;&quot;&quot;</span>
    393. 

  393. <span class="sd">		Resets the values of the statistics.</span>
    394. 

  394. <span class="sd">		Should be called when the model is used in multiple</span>
    395. 

  395. <span class="sd">		simulations back-to-back to make sure the statistics</span>
    396. 

  396. <span class="sd">		remain valid.</span>
    397. 

  397. <span class="sd">		&quot;&quot;&quot;</span>
    398. 

  398. 		<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;count&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span>
    399. 

  399. 		<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;sum&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="mf">0.0</span>
    400. 

  400. 		<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;sumOfSquares&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="mf">0.0</span>
    401. 

  401. 		<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;min&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="s1">&#39;inf&#39;</span><span class="p">)</span>
    402. 

  402. 		<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;max&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="o">-</span><span class="nb">float</span><span class="p">(</span><span class="s1">&#39;inf&#39;</span><span class="p">)</span></div>
    403. 

  403. 

  404. <div class="viewcode-block" id="StatisticsCollectorBlock.count"><a class="viewcode-back" href="../../../CBD.lib.endpoints.html#CBD.lib.endpoints.StatisticsCollectorBlock.count">[docs]</a>	<span class="k">def</span> <span class="nf">count</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    405. 

  405. 		<span class="sd">&quot;&quot;&quot;</span>
    406. 

  406. <span class="sd">		Returns the amount of items that have been captured.</span>
    407. 

  407. <span class="sd">		&quot;&quot;&quot;</span>
    408. 

  408. 		<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;count&quot;</span><span class="p">]</span></div>
    409. 

  409. 

  410. <div class="viewcode-block" id="StatisticsCollectorBlock.min"><a class="viewcode-back" href="../../../CBD.lib.endpoints.html#CBD.lib.endpoints.StatisticsCollectorBlock.min">[docs]</a>	<span class="k">def</span> <span class="nf">min</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    411. 

  411. 		<span class="sd">&quot;&quot;&quot;</span>
    412. 

  412. <span class="sd">		Returns the smallest value that was seen.</span>
    413. 

  413. <span class="sd">		&quot;&quot;&quot;</span>
    414. 

  414. 		<span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;min&quot;</span><span class="p">])</span></div>
    415. 

  415. 

  416. <div class="viewcode-block" id="StatisticsCollectorBlock.max"><a class="viewcode-back" href="../../../CBD.lib.endpoints.html#CBD.lib.endpoints.StatisticsCollectorBlock.max">[docs]</a>	<span class="k">def</span> <span class="nf">max</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    417. 

  417. 		<span class="sd">&quot;&quot;&quot;</span>
    418. 

  418. <span class="sd">		Returns the largest value that was seen.</span>
    419. 

  419. <span class="sd">		&quot;&quot;&quot;</span>
    420. 

  420. 		<span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;max&quot;</span><span class="p">])</span></div>
    421. 

  421. 

  422. <div class="viewcode-block" id="StatisticsCollectorBlock.sum"><a class="viewcode-back" href="../../../CBD.lib.endpoints.html#CBD.lib.endpoints.StatisticsCollectorBlock.sum">[docs]</a>	<span class="k">def</span> <span class="nf">sum</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    423. 

  423. 		<span class="sd">&quot;&quot;&quot;</span>
    424. 

  424. <span class="sd">		Returns the sum of all items that have been captured.</span>
    425. 

  425. <span class="sd">		&quot;&quot;&quot;</span>
    426. 

  426. 		<span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;sum&quot;</span><span class="p">])</span></div>
    427. 

  427. 

  428. <div class="viewcode-block" id="StatisticsCollectorBlock.sumOfSquares"><a class="viewcode-back" href="../../../CBD.lib.endpoints.html#CBD.lib.endpoints.StatisticsCollectorBlock.sumOfSquares">[docs]</a>	<span class="k">def</span> <span class="nf">sumOfSquares</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    429. 

  429. 		<span class="sd">&quot;&quot;&quot;</span>
    430. 

  430. <span class="sd">		Returns the sum of the squares for all items that have been captured.</span>
    431. 

  431. <span class="sd">		&quot;&quot;&quot;</span>
    432. 

  432. 		<span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;sumOfSquares&quot;</span><span class="p">])</span></div>
    433. 

  433. 

  434. <div class="viewcode-block" id="StatisticsCollectorBlock.mean"><a class="viewcode-back" href="../../../CBD.lib.endpoints.html#CBD.lib.endpoints.StatisticsCollectorBlock.mean">[docs]</a>	<span class="k">def</span> <span class="nf">mean</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    435. 

  435. 		<span class="sd">&quot;&quot;&quot;</span>
    436. 

  436. <span class="sd">		Returns the average/mean value of the data.</span>
    437. 

  437. <span class="sd">		&quot;&quot;&quot;</span>
    438. 

  438. 		<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">count</span><span class="p">()</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
    439. 

  439. 			<span class="k">return</span> <span class="mf">0.0</span>
    440. 

  440. 		<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">sum</span><span class="p">()</span> <span class="o">/</span> <span class="bp">self</span><span class="o">.</span><span class="n">count</span><span class="p">()</span></div>
    441. 

  441. 

  442. <div class="viewcode-block" id="StatisticsCollectorBlock.variance"><a class="viewcode-back" href="../../../CBD.lib.endpoints.html#CBD.lib.endpoints.StatisticsCollectorBlock.variance">[docs]</a>	<span class="k">def</span> <span class="nf">variance</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    443. 

  443. 		<span class="sd">&quot;&quot;&quot;</span>
    444. 

  444. <span class="sd">		Returns the variance of the data.</span>
    445. 

  445. <span class="sd">		&quot;&quot;&quot;</span>
    446. 

  446. 		<span class="n">mu</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">mean</span><span class="p">()</span>
    447. 

  447. 		<span class="n">n</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">count</span><span class="p">()</span>
    448. 

  448. 		<span class="n">s</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">sum</span><span class="p">()</span>
    449. 

  449. 		<span class="n">sq</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">sumOfSquares</span><span class="p">()</span>
    450. 

  450. 		<span class="k">if</span> <span class="n">n</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
    451. 

  451. 			<span class="k">return</span> <span class="mf">0.0</span>
    452. 

  452. 		<span class="k">return</span> <span class="n">sq</span> <span class="o">/</span> <span class="n">n</span> <span class="o">+</span> <span class="n">mu</span> <span class="o">**</span> <span class="mf">2.0</span> <span class="o">-</span> <span class="p">(</span><span class="mf">2.0</span> <span class="o">*</span> <span class="n">mu</span> <span class="o">*</span> <span class="n">s</span><span class="p">)</span> <span class="o">/</span> <span class="n">n</span></div>
    453. 

  453. 

  454. <div class="viewcode-block" id="StatisticsCollectorBlock.std"><a class="viewcode-back" href="../../../CBD.lib.endpoints.html#CBD.lib.endpoints.StatisticsCollectorBlock.std">[docs]</a>	<span class="k">def</span> <span class="nf">std</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    455. 

  455. 		<span class="sd">&quot;&quot;&quot;</span>
    456. 

  456. <span class="sd">		Returns the standard deviation value of the data.</span>
    457. 

  457. <span class="sd">		&quot;&quot;&quot;</span>
    458. 

  458. 		<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">variance</span><span class="p">()</span> <span class="o">**</span> <span class="mf">0.5</span></div></div>
    459. 

  459. </pre></div>
    460. 

  460. 

  461.              </article>
    462. 

  462.              
    463. 

  463.             </div>
    464. 

  464.             <footer>
    465. 

  465.   
    466. 

  466. 

  467.   <hr>
    468. 

  468. 

  469.   <div role="contentinfo">
    470. 

  470.     <p>
    471. 

  471.         &copy; Copyright 2020, Randy Paredis.
    472. 

  472. 

  473.     </p>
    474. 

  474.   </div>
    475. 

  475.     
    476. 

  476.       <div>
    477. 

  477.         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>.
    478. 

  478.       </div>
    479. 

  479.      
    480. 

  480. 

  481. </footer>
    482. 

  482. 

  483.           </div>
    484. 

  484.         </div>
    485. 

  485. 

  486.         <div class="catalyst-content-right" id="catalyst-content-right">
    487. 

  487.           <div class="catalyst-right-menu" id="catalyst-right-menu">
    488. 

  488.             <div class="catalyst-side-scroll" id="catalyst-side-scroll-right">
    489. 

  489.               
    490. 

  490.             </div>
    491. 

  491.           </div>
    492. 

  492.         </div>
    493. 

  493.       </section>
    494. 

  494.     </div>
    495. 

  495. 

  496.   
    497. 

  497. 

  498. 

  499.   
    500. 

  500. 

  501.      
    502. 

  502.        <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
    503. 

  503.          <script type="text/javascript" src="../../../_static/jquery.js"></script>
    504. 

  504.          <script type="text/javascript" src="../../../_static/underscore.js"></script>
    505. 

  505.          <script type="text/javascript" src="../../../_static/doctools.js"></script>
    506. 

  506.          <script type="text/javascript" src="../../../_static/language_data.js"></script>
    507. 

  507.          <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
    508. 

  508.      
    509. 

  509. 

  510.   
    511. 

  511. 

  512.   <script type="text/javascript" src="../../../_static/js/vendor/popper.min.js"></script>
    513. 

  513.   <script type="text/javascript" src="../../../_static/js/vendor/bootstrap.min.js"></script>
    514. 

  514.   <script type="text/javascript" src="../../../_static/js/theme.js"></script>
    515. 

  515. 

  516.   <script type="text/javascript">
    517. 

  517.       jQuery(function () {
    518. 

  518.           SphinxRtdTheme.Navigation.enable(true);
    519. 

  519.       });
    520. 

  520.   </script> 
    521. 

  521. 

  522.   <!-- Begin Footer -->
    523. 

  523. 

  524.   <footer class="site-footer" id="site-footer">
    525. 

  525.     <div class="container footer-container">
    526. 

  526.       <div class="footer-logo-wrapper">
    527. 

  527.         <a href="https://catalyst-team.com/" class="footer-logo"></a>
    528. 

  528.       </div>
    529. 

  529. 

  530.       <div class="footer-links-wrapper">
    531. 

  531.         <div class="footer-links-col">
    532. 

  532.           <ul>
    533. 

  533.             <li class="list-title"><a href="https://github.com/catalyst-team">Ecosystem</a></li>
    534. 

  534.             <li><a class="nav-dropdown-item" href="https://alchemy.host">Alchemy</a></li>
    535. 

  535.             <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">Catalyst</a></li>
    536. 

  536.             <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">Reaction</a></li>
    537. 

  537.           </ul>
    538. 

  538.         </div>
    539. 

  539. 

  540.         <div class="footer-links-col">
    541. 

  541.           <ul>
    542. 

  542.             <li class="list-title"><a href="https://github.com/catalyst-team">Projects</a></li>
    543. 

  543.             <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">Codestyle</a></li>
    544. 

  544.             <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">Catalyst.Neuro</a></li>
    545. 

  545.             <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">Classification</a></li>
    546. 

  546.             <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">Detection</a></li>
    547. 

  547.             <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">Segmentation</a></li>
    548. 

  548.             <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">Catalyst.GAN</a></li>
    549. 

  549.           </ul>
    550. 

  550.         </div>
    551. 

  551. 

  552.         <div class="footer-links-col">
    553. 

  553.           <ul>
    554. 

  554.             <li class="list-title"><a href="https://catalyst-team.com/">Support</a></li>
    555. 

  555.             <li><a href="https://github.com/catalyst-team/catalyst/issues" target="_blank">Github Issues</a></li>
    556. 

  556.             <li><a href="https://github.com/catalyst-team/catalyst/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
    557. 

  557.             <li><a href="https://www.patreon.com/catalyst_team" target="_blank">Patreon</a></li>
    558. 

  558.           </ul>
    559. 

  559.         </div>
    560. 

  560. 

  561.         <div class="footer-links-col follow-us-col">
    562. 

  562.           <div class="footer-social-icons">
    563. 

  563.             <a href="https://t.me/catalyst_team" target="_blank" class="telegram"></a>
    564. 

  564.             <a href="https://twitter.com/catalyst_core" target="_blank" class="twitter"></a>
    565. 

  565.             <a href="https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw" target="_blank" class="ods"></a>
    566. 

  566.           </div>
    567. 

  567.         </div>
    568. 

  568.       </div>
    569. 

  569.     </div>
    570. 

  570.   </footer>
    571. 

  571. 

  572. 

  573.   <!-- End Footer -->
    574. 

  574. 

  575.   <!-- Begin Mobile Menu -->
    576. 

  576. 

  577.   <div class="mobile-main-menu">
    578. 

  578.     <div class="container-fluid">
    579. 

  579.       <div class="container">
    580. 

  580.         <div class="mobile-main-menu-header-container">
    581. 

  581.           <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
    582. 

  582.           <a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>
    583. 

  583.         </div>
    584. 

  584.       </div>
    585. 

  585.     </div>
    586. 

  586. 

  587.     <div class="mobile-main-menu-links-container">
    588. 

  588.       <div class="main-menu">
    589. 

  589.         <ul>
    590. 

  590.           <li>
    591. 

  591.             <a href="">Get Started</a>
    592. 

  592.           </li>
    593. 

  593. 

  594.           <li>
    595. 

  595.             <a href="https://github.com/catalyst-team/catalyst">Github</a>
    596. 

  596.           </li>
    597. 

  597.         </ul>
    598. 

  598.       </div>
    599. 

  599.     </div>
    600. 

  600.   </div>
    601. 

  601. 

  602.   <!-- End Mobile Menu -->
    603. 

  603. 

  604.   <script type="text/javascript" src="../../../_static/js/vendor/anchor.min.js"></script>
    605. 

  605. 

  606.   <script type="text/javascript">
    607. 

  607.     $(document).ready(function() {
    608. 

  608.       mobileMenu.bind();
    609. 

  609.       mobileTOC.bind();
    610. 

  610.       catalystAnchors.bind();
    611. 

  611.       sideMenus.bind();
    612. 

  612.       scrollToAnchor.bind();
    613. 

  613.       highlightNavigation.bind();
    614. 

  614.       mainMenuDropdown.bind();
    615. 

  615. 

  616.       // Add class to links that have code blocks, since we cannot create links in code blocks
    617. 

  617.       $("article.catalyst-article a span.pre").each(function(e) {
    618. 

  618.         $(this).closest("a").addClass("has-code");
    619. 

  619.       });
    620. 

  620.     })
    621. 

  621.   </script>
    622. 

  622. </body>
    623. 

  623. </html>
    624.