


<!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="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Index &mdash; LEAF 0.1 documentation</title>
  

  
  
  
  

  

  
  
    

  

  <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/customheader.css" type="text/css" />
    <link rel="index" title="Index" href="#" />
    <link rel="search" title="Search" href="search.html" /> 

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

</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"> LEAF
          

          
          </a>

          
            
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="install/get_leaf.html">Installation and Contribution</a></li>
</ul>
<p class="caption"><span class="caption-text">User Guide</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="tutorials/index.html">General Examples</a></li>
</ul>
<p class="caption"><span class="caption-text">API Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="autodoc/modules.html">models</a></li>
</ul>
<p class="caption"><span class="caption-text">Additional Information</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="contact.html">Contact</a></li>
<li class="toctree-l1"><a class="reference internal" href="citations.html">Citing LEAF</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">LEAF</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>Index</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            

<h1 id="index">Index</h1>

<div class="genindex-jumpbox">
 <a href="#B"><strong>B</strong></a>
 | <a href="#C"><strong>C</strong></a>
 | <a href="#G"><strong>G</strong></a>
 | <a href="#L"><strong>L</strong></a>
 | <a href="#M"><strong>M</strong></a>
 | <a href="#N"><strong>N</strong></a>
 | <a href="#O"><strong>O</strong></a>
 | <a href="#P"><strong>P</strong></a>
 | <a href="#R"><strong>R</strong></a>
 | <a href="#S"><strong>S</strong></a>
 | <a href="#T"><strong>T</strong></a>
 | <a href="#U"><strong>U</strong></a>
 | <a href="#V"><strong>V</strong></a>
 | <a href="#W"><strong>W</strong></a>
 
</div>
<h2 id="B">B</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="autodoc/utils.html#utils.language_utils.bag_of_words">bag_of_words() (in module utils.language_utils)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="autodoc/baseline_constants.html#module-baseline_constants">baseline_constants (module)</a>
</li>
      <li><a href="autodoc/utils.html#utils.model_utils.batch_data">batch_data() (in module utils.model_utils)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="autodoc/client.html#client.Client">Client (class in client)</a>
</li>
      <li><a href="autodoc/client.html#module-client">client (module)</a>
</li>
      <li><a href="autodoc/model.html#model.Model.close">close() (model.Model method)</a>

      <ul>
        <li><a href="autodoc/model.html#model.ServerModel.close">(model.ServerModel method)</a>
</li>
      </ul></li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="autodoc/model.html#model.Model.create_model">create_model() (model.Model method)</a>
</li>
      <li><a href="autodoc/model.html#model.ServerModel.cur_model">cur_model (model.ServerModel attribute)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="autodoc/server.html#server.Server.get_clients_test_info">get_clients_test_info() (server.Server method)</a>
</li>
      <li><a href="autodoc/metrics.html#metrics.visualization_utils.get_longest_flops_path">get_longest_flops_path() (in module metrics.visualization_utils)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="autodoc/metrics.html#metrics.writer.get_metrics_names">get_metrics_names() (in module metrics.writer)</a>
</li>
      <li><a href="autodoc/utils.html#utils.language_utils.get_word_emb_arr">get_word_emb_arr() (in module utils.language_utils)</a>
</li>
      <li><a href="autodoc/utils.html#utils.tf_utils.graph_size">graph_size() (in module utils.tf_utils)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="autodoc/utils.html#utils.language_utils.letter_to_vec">letter_to_vec() (in module utils.language_utils)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="autodoc/utils.html#utils.language_utils.line_to_indices">line_to_indices() (in module utils.language_utils)</a>
</li>
      <li><a href="autodoc/metrics.html#metrics.visualization_utils.load_data">load_data() (in module metrics.visualization_utils)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="autodoc/main.html#module-main">main (module)</a>
</li>
      <li><a href="autodoc/main.html#main.main">main() (in module main)</a>
</li>
      <li><a href="autodoc/baseline_constants.html#baseline_constants.MAIN_PARAMS">MAIN_PARAMS (in module baseline_constants)</a>
</li>
      <li><a href="autodoc/metrics.html#module-metrics">metrics (module)</a>
</li>
      <li><a href="autodoc/metrics.html#module-metrics.visualization_utils">metrics.visualization_utils (module)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="autodoc/metrics.html#module-metrics.writer">metrics.writer (module)</a>
</li>
      <li><a href="autodoc/model.html#model.Model">Model (class in model)</a>
</li>
      <li><a href="autodoc/client.html#client.Client.model">model (client.Client attribute)</a>

      <ul>
        <li><a href="autodoc/model.html#module-model">(module)</a>
</li>
      </ul></li>
      <li><a href="autodoc/baseline_constants.html#baseline_constants.MODEL_PARAMS">MODEL_PARAMS (in module baseline_constants)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="N">N</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="autodoc/client.html#client.Client.num_test_samples">num_test_samples (client.Client attribute)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="O">O</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="autodoc/main.html#main.online">online() (in module main)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="autodoc/model.html#model.Model.optimizer">optimizer (model.Model attribute)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="autodoc/main.html#main.parse_args">parse_args() (in module main)</a>
</li>
      <li><a href="autodoc/metrics.html#metrics.visualization_utils.plot_accuracy_vs_round_number">plot_accuracy_vs_round_number() (in module metrics.visualization_utils)</a>
</li>
      <li><a href="autodoc/metrics.html#metrics.visualization_utils.plot_accuracy_vs_round_number_per_client">plot_accuracy_vs_round_number_per_client() (in module metrics.visualization_utils)</a>
</li>
      <li><a href="autodoc/metrics.html#metrics.visualization_utils.plot_bytes_written_and_read">plot_bytes_written_and_read() (in module metrics.visualization_utils)</a>
</li>
      <li><a href="autodoc/metrics.html#metrics.visualization_utils.plot_client_computations_vs_round_number">plot_client_computations_vs_round_number() (in module metrics.visualization_utils)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="autodoc/metrics.html#metrics.writer.print_dataframe">print_dataframe() (in module metrics.writer)</a>
</li>
      <li><a href="autodoc/main.html#main.print_metrics">print_metrics() (in module main)</a>

      <ul>
        <li><a href="autodoc/metrics.html#metrics.writer.print_metrics">(in module metrics.writer)</a>
</li>
      </ul></li>
      <li><a href="autodoc/model.html#model.Model.process_x">process_x() (model.Model method)</a>
</li>
      <li><a href="autodoc/model.html#model.Model.process_y">process_y() (model.Model method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="autodoc/utils.html#utils.model_utils.read_data">read_data() (in module utils.model_utils)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="autodoc/model.html#model.ServerModel.save">save() (model.ServerModel method)</a>
</li>
      <li><a href="autodoc/main.html#main.save_model">save_model() (in module main)</a>
</li>
      <li><a href="autodoc/server.html#server.Server.select_clients">select_clients() (server.Server method)</a>
</li>
      <li><a href="autodoc/model.html#model.ServerModel.send_to">send_to() (model.ServerModel method)</a>
</li>
      <li><a href="autodoc/server.html#server.Server">Server (class in server)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="autodoc/server.html#module-server">server (module)</a>
</li>
      <li><a href="autodoc/model.html#model.ServerModel">ServerModel (class in model)</a>
</li>
      <li><a href="autodoc/main.html#main.setup_clients">setup_clients() (in module main)</a>
</li>
      <li><a href="autodoc/baseline_constants.html#baseline_constants.SIM_TIMES">SIM_TIMES (in module baseline_constants)</a>
</li>
      <li><a href="autodoc/model.html#model.ServerModel.size">size (model.ServerModel attribute)</a>
</li>
      <li><a href="autodoc/utils.html#utils.language_utils.split_line">split_line() (in module utils.language_utils)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="autodoc/client.html#client.Client.test">test() (client.Client method)</a>

      <ul>
        <li><a href="autodoc/model.html#model.Model.test">(model.Model method)</a>
</li>
      </ul></li>
      <li><a href="autodoc/server.html#server.Server.test_model">test_model() (server.Server method)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="autodoc/client.html#client.Client.train">train() (client.Client method)</a>

      <ul>
        <li><a href="autodoc/model.html#model.Model.train">(model.Model method)</a>
</li>
      </ul></li>
      <li><a href="autodoc/server.html#server.Server.train_model">train_model() (server.Server method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="U">U</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="autodoc/model.html#model.ServerModel.update">update() (model.ServerModel method)</a>
</li>
      <li><a href="autodoc/server.html#server.Server.update_model">update_model() (server.Server method)</a>
</li>
      <li><a href="autodoc/utils.html#module-utils">utils (module)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="autodoc/utils.html#module-utils.constants">utils.constants (module)</a>
</li>
      <li><a href="autodoc/utils.html#module-utils.language_utils">utils.language_utils (module)</a>
</li>
      <li><a href="autodoc/utils.html#module-utils.model_utils">utils.model_utils (module)</a>
</li>
      <li><a href="autodoc/utils.html#module-utils.tf_utils">utils.tf_utils (module)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="V">V</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="autodoc/utils.html#utils.language_utils.val_to_vec">val_to_vec() (in module utils.language_utils)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="W">W</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="autodoc/utils.html#utils.language_utils.word_to_indices">word_to_indices() (in module utils.language_utils)</a>
</li>
  </ul></td>
</tr></table>



           </div>
           
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2019, Talwalkar Lab

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    
    
      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
        <script type="text/javascript" src="_static/jquery.js"></script>
        <script type="text/javascript" src="_static/underscore.js"></script>
        <script type="text/javascript" src="_static/doctools.js"></script>
    

  

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

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

</body>
</html>