a b/docs/_build/html/index.html 

  1
  





  
  

  2
  





  
  

  3
  
<!DOCTYPE html>





  
  

  4
  
<html class="writer-html5" lang="en" >





  
  

  5
  
<head>





  
  

  6
  
  <meta charset="utf-8" />





  
  

  7
  
  





  
  

  8
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />





  
  

  9
  
  





  
  

  10
  
  <title>Welcome to DeepProg’s documentation! &mdash; DeepProg  documentation</title>





  
  

  11
  
  





  
  

  12
  





  
  

  13
  
  





  
  

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





  
  

  15
  
  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />





  
  

  16
  





  
  

  17
  
  





  
  

  18
  
  





  
  

  19
  





  
  

  20
  
  





  
  

  21
  
  





  
  

  22
  





  
  

  23
  
  





  
  

  24
  





  
  

  25
  
  





  
  

  26
  
  <!--[if lt IE 9]>





  
  

  27
  
    <script src="_static/js/html5shiv.min.js"></script>





  
  

  28
  
  <![endif]-->





  
  

  29
  
  





  
  

  30
  
    





  
  

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





  
  

  32
  
        <script src="_static/jquery.js"></script>





  
  

  33
  
        <script src="_static/underscore.js"></script>





  
  

  34
  
        <script src="_static/doctools.js"></script>





  
  

  35
  
        <script src="_static/language_data.js"></script>





  
  

  36
  
    





  
  

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





  
  

  38
  





  
  

  39
  
    





  
  

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





  
  

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





  
  

  42
  
    <link rel="next" title="Installation" href="installation.html" /> 





  
  

  43
  
</head>





  
  

  44
  





  
  

  45
  
<body class="wy-body-for-nav">





  
  

  46
  





  
  

  47
  
   





  
  

  48
  
  <div class="wy-grid-for-nav">





  
  

  49
  
    





  
  

  50
  
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">





  
  

  51
  
      <div class="wy-side-scroll">





  
  

  52
  
        <div class="wy-side-nav-search" >





  
  

  53
  
          





  
  

  54
  





  
  

  55
  
          





  
  

  56
  
            <a href="#" class="icon icon-home"> DeepProg





  
  

  57
  
          





  
  

  58
  





  
  

  59
  
          





  
  

  60
  
          </a>





  
  

  61
  





  
  

  62
  
          





  
  

  63
  
            





  
  

  64
  
            





  
  

  65
  
          





  
  

  66
  





  
  

  67
  
          





  
  

  68
  
<div role="search">





  
  

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





  
  

  70
  
    <input type="text" name="q" placeholder="Search docs" />





  
  

  71
  
    <input type="hidden" name="check_keywords" value="yes" />





  
  

  72
  
    <input type="hidden" name="area" value="default" />





  
  

  73
  
  </form>





  
  

  74
  
</div>





  
  

  75
  





  
  

  76
  
          





  
  

  77
  
        </div>





  
  

  78
  





  
  

  79
  
        





  
  

  80
  
        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">





  
  

  81
  
          





  
  

  82
  
            





  
  

  83
  
            





  
  

  84
  
              





  
  

  85
  
            





  
  

  86
  
            





  
  

  87
  
              <ul>





  
  

  88
  
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>





  
  

  89
  
<li class="toctree-l1"><a class="reference internal" href="usage.html">Tutorial: Simple DeepProg model</a></li>





  
  

  90
  
<li class="toctree-l1"><a class="reference internal" href="usage_ensemble.html">Tutorial: Ensemble of DeepProg model</a></li>





  
  

  91
  
<li class="toctree-l1"><a class="reference internal" href="usage_advanced.html">Tutorial: Advanced usage of DeepProg model</a></li>





  
  

  92
  
<li class="toctree-l1"><a class="reference internal" href="case_study.html">Case study: Analyzing TCGA HCC dataset</a></li>





  
  

  93
  
<li class="toctree-l1"><a class="reference internal" href="usage_tuning.html">Tutorial: Tuning DeepProg</a></li>





  
  

  94
  
<li class="toctree-l1"><a class="reference internal" href="LICENSE.html">License</a></li>





  
  

  95
  
<li class="toctree-l1"><a class="reference internal" href="api/simdeep.html">simdeep package</a></li>





  
  

  96
  
</ul>





  
  

  97
  





  
  

  98
  
            





  
  

  99
  
          





  
  

  100
  
        </div>





  
  

  101
  
        





  
  

  102
  
      </div>





  
  

  103
  
    </nav>





  
  

  104
  





  
  

  105
  
    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">





  
  

  106
  





  
  

  107
  
      





  
  

  108
  
      <nav class="wy-nav-top" aria-label="top navigation">





  
  

  109
  
        





  
  

  110
  
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>





  
  

  111
  
          <a href="#">DeepProg</a>





  
  

  112
  
        





  
  

  113
  
      </nav>





  
  

  114
  





  
  

  115
  





  
  

  116
  
      <div class="wy-nav-content">





  
  

  117
  
        





  
  

  118
  
        <div class="rst-content">





  
  

  119
  
        





  
  

  120
  
          





  
  

  121
  





  
  

  122
  





  
  

  123
  





  
  

  124
  





  
  

  125
  





  
  

  126
  





  
  

  127
  





  
  

  128
  





  
  

  129
  





  
  

  130
  





  
  

  131
  





  
  

  132
  





  
  

  133
  





  
  

  134
  





  
  

  135
  





  
  

  136
  





  
  

  137
  





  
  

  138
  
<div role="navigation" aria-label="breadcrumbs navigation">





  
  

  139
  





  
  

  140
  
  <ul class="wy-breadcrumbs">





  
  

  141
  
    





  
  

  142
  
      <li><a href="#" class="icon icon-home"></a> &raquo;</li>





  
  

  143
  
        





  
  

  144
  
      <li>Welcome to DeepProg’s documentation!</li>





  
  

  145
  
    





  
  

  146
  
    





  
  

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





  
  

  148
  
        





  
  

  149
  
          





  
  

  150
  
            <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>





  
  

  151
  
          





  
  

  152
  
        





  
  

  153
  
      </li>





  
  

  154
  
    





  
  

  155
  
  </ul>





  
  

  156
  





  
  

  157
  
  





  
  

  158
  
  <hr/>





  
  

  159
  
</div>





  
  

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





  
  

  161
  
           <div itemprop="articleBody">





  
  

  162
  
            





  
  

  163
  
  <div class="section" id="welcome-to-deepprog-s-documentation">





  
  

  164
  
<h1>Welcome to DeepProg’s documentation!<a class="headerlink" href="#welcome-to-deepprog-s-documentation" title="Permalink to this headline">¶</a></h1>





  
  

  165
  
<div class="toctree-wrapper compound">





  
  

  166
  
<ul>





  
  

  167
  
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>





  
  

  168
  
<li class="toctree-l2"><a class="reference internal" href="installation.html#requirements">Requirements</a></li>





  
  

  169
  
<li class="toctree-l2"><a class="reference internal" href="installation.html#tested-python-package-versions">Tested python package versions</a></li>





  
  

  170
  
<li class="toctree-l2"><a class="reference internal" href="installation.html#deep-learning-packages-installation">Deep-Learning packages installation</a></li>





  
  

  171
  
<li class="toctree-l2"><a class="reference internal" href="installation.html#support-for-cntk-tensorflow">Support for CNTK / tensorflow</a></li>





  
  

  172
  
<li class="toctree-l2"><a class="reference internal" href="installation.html#distributed-computation">Distributed computation</a></li>





  
  

  173
  
<li class="toctree-l2"><a class="reference internal" href="installation.html#visualisation-module-experimental">Visualisation module (Experimental)</a></li>





  
  

  174
  
<li class="toctree-l2"><a class="reference internal" href="installation.html#usage">Usage</a></li>





  
  

  175
  
<li class="toctree-l2"><a class="reference internal" href="installation.html#example-scripts">Example scripts</a></li>





  
  

  176
  
</ul>





  
  

  177
  
</li>





  
  

  178
  
<li class="toctree-l1"><a class="reference internal" href="usage.html">Tutorial: Simple DeepProg model</a><ul>





  
  

  179
  
<li class="toctree-l2"><a class="reference internal" href="usage.html#input-parameters">Input parameters</a></li>





  
  

  180
  
<li class="toctree-l2"><a class="reference internal" href="usage.html#input-matrices">Input matrices</a></li>





  
  

  181
  
<li class="toctree-l2"><a class="reference internal" href="usage.html#creating-a-simple-deepprog-model-with-one-autoencoder-for-each-omic">Creating a simple DeepProg model with one autoencoder for each omic</a></li>





  
  

  182
  
</ul>





  
  

  183
  
</li>





  
  

  184
  
<li class="toctree-l1"><a class="reference internal" href="usage_ensemble.html">Tutorial: Ensemble of DeepProg model</a><ul>





  
  

  185
  
<li class="toctree-l2"><a class="reference internal" href="usage_ensemble.html#instanciation">Instanciation</a></li>





  
  

  186
  
<li class="toctree-l2"><a class="reference internal" href="usage_ensemble.html#fitting">Fitting</a></li>





  
  

  187
  
<li class="toctree-l2"><a class="reference internal" href="usage_ensemble.html#evaluate-the-models">Evaluate the models</a></li>





  
  

  188
  
<li class="toctree-l2"><a class="reference internal" href="usage_ensemble.html#predicting-on-test-dataset">Predicting on test dataset</a></li>





  
  

  189
  
<li class="toctree-l2"><a class="reference internal" href="usage_ensemble.html#distributed-computation">Distributed computation</a></li>





  
  

  190
  
<li class="toctree-l2"><a class="reference internal" href="usage_ensemble.html#more-examples">More examples</a></li>





  
  

  191
  
</ul>





  
  

  192
  
</li>





  
  

  193
  
<li class="toctree-l1"><a class="reference internal" href="usage_advanced.html">Tutorial: Advanced usage of DeepProg model</a><ul>





  
  

  194
  
<li class="toctree-l2"><a class="reference internal" href="usage_advanced.html#visualisation">Visualisation</a></li>





  
  

  195
  
<li class="toctree-l2"><a class="reference internal" href="usage_advanced.html#hyperparameters">Hyperparameters</a></li>





  
  

  196
  
<li class="toctree-l2"><a class="reference internal" href="usage_advanced.html#usage-of-metadata-associated-with-patients">Usage of metadata associated with patients</a></li>





  
  

  197
  
<li class="toctree-l2"><a class="reference internal" href="usage_advanced.html#computing-cluster-specific-feature-signatures">Computing cluster-specific feature signatures</a></li>





  
  

  198
  
<li class="toctree-l2"><a class="reference internal" href="usage_advanced.html#save-load-models">Save / load models</a></li>





  
  

  199
  
</ul>





  
  

  200
  
</li>





  
  

  201
  
<li class="toctree-l1"><a class="reference internal" href="case_study.html">Case study: Analyzing TCGA HCC dataset</a><ul>





  
  

  202
  
<li class="toctree-l2"><a class="reference internal" href="case_study.html#dataset-preparation">Dataset preparation</a></li>





  
  

  203
  
<li class="toctree-l2"><a class="reference internal" href="case_study.html#model-fitting">Model fitting</a></li>





  
  

  204
  
<li class="toctree-l2"><a class="reference internal" href="case_study.html#visualisation-and-analysis">Visualisation and analysis</a></li>





  
  

  205
  
</ul>





  
  

  206
  
</li>





  
  

  207
  
<li class="toctree-l1"><a class="reference internal" href="usage_tuning.html">Tutorial: Tuning DeepProg</a><ul>





  
  

  208
  
<li class="toctree-l2"><a class="reference internal" href="usage_tuning.html#a-first-example">A first example</a></li>





  
  

  209
  
<li class="toctree-l2"><a class="reference internal" href="usage_tuning.html#tuning-using-one-or-multiple-test-datasets">Tuning using one or multiple test datasets</a></li>





  
  

  210
  
<li class="toctree-l2"><a class="reference internal" href="usage_tuning.html#results">Results</a></li>





  
  

  211
  
<li class="toctree-l2"><a class="reference internal" href="usage_tuning.html#recommendation">Recommendation</a></li>





  
  

  212
  
</ul>





  
  

  213
  
</li>





  
  

  214
  
<li class="toctree-l1"><a class="reference internal" href="LICENSE.html">License</a></li>





  
  

  215
  
<li class="toctree-l1"><a class="reference internal" href="api/simdeep.html">simdeep package</a><ul>





  
  

  216
  
<li class="toctree-l2"><a class="reference internal" href="api/simdeep.html#submodules">Submodules</a></li>





  
  

  217
  
<li class="toctree-l2"><a class="reference internal" href="api/simdeep.html#module-simdeep.config">simdeep.config module</a></li>





  
  

  218
  
<li class="toctree-l2"><a class="reference internal" href="api/simdeep.html#module-simdeep.coxph_from_r">simdeep.coxph_from_r module</a></li>





  
  

  219
  
<li class="toctree-l2"><a class="reference internal" href="api/simdeep.html#module-simdeep.deepmodel_base">simdeep.deepmodel_base module</a></li>





  
  

  220
  
<li class="toctree-l2"><a class="reference internal" href="api/simdeep.html#module-simdeep.extract_data">simdeep.extract_data module</a></li>





  
  

  221
  
<li class="toctree-l2"><a class="reference internal" href="api/simdeep.html#module-simdeep.plot_utils">simdeep.plot_utils module</a></li>





  
  

  222
  
<li class="toctree-l2"><a class="reference internal" href="api/simdeep.html#module-simdeep.simdeep_analysis">simdeep.simdeep_analysis module</a></li>





  
  

  223
  
<li class="toctree-l2"><a class="reference internal" href="api/simdeep.html#module-simdeep.simdeep_boosting">simdeep.simdeep_boosting module</a></li>





  
  

  224
  
<li class="toctree-l2"><a class="reference internal" href="api/simdeep.html#module-simdeep.simdeep_distributed">simdeep.simdeep_distributed module</a></li>





  
  

  225
  
<li class="toctree-l2"><a class="reference internal" href="api/simdeep.html#module-simdeep.simdeep_multiple_dataset">simdeep.simdeep_multiple_dataset module</a></li>





  
  

  226
  
<li class="toctree-l2"><a class="reference internal" href="api/simdeep.html#module-simdeep.simdeep_utils">simdeep.simdeep_utils module</a></li>





  
  

  227
  
<li class="toctree-l2"><a class="reference internal" href="api/simdeep.html#module-simdeep.survival_utils">simdeep.survival_utils module</a></li>





  
  

  228
  
<li class="toctree-l2"><a class="reference internal" href="api/simdeep.html#module-simdeep">Module contents</a></li>





  
  

  229
  
</ul>





  
  

  230
  
</li>





  
  

  231
  
</ul>





  
  

  232
  
</div>





  
  

  233
  
<div class="section" id="introduction">





  
  

  234
  
<h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>





  
  

  235
  
<p>This package allows to combine multi-omics data for individual samples together with survival. Using autoencoders (default) or any alternative embedding methods, the pipeline creates new set of features and identifies those linked with survival. In a second time, the samples are clustered with different possible strategies to obtain robust subtypes linked to survival. The robustness of the obtained subtypes can then be tested externally on one or multiple validation datasets and/or the <em>out-of-bags</em> samples.  The omic data used in the original study are RNA-Seq, MiR and Methylation. However, this approach can be extended to any combination of omic data. The current package contains the omic data used in the study and a copy of the model computed. However, it is easy to recreate a new model from scratch using any combination of omic data.





  
  

  236
  
The omic data and the survival files should be in tsv (Tabular Separated Values) format and examples are provided. The deep-learning framework to produce the autoencoders uses Keras with either Theano / tensorflow/ CNTK as background.</p>





  
  

  237
  
<img alt="_images/workflow.png" src="_images/workflow.png" />





  
  

  238
  
</div>





  
  

  239
  
<div class="section" id="access">





  
  

  240
  
<h2>Access<a class="headerlink" href="#access" title="Permalink to this headline">¶</a></h2>





  
  

  241
  
<p>The package is accessible at this link: <a class="reference external" href="https://github.com/lanagarmire/DeepProg">https://github.com/lanagarmire/DeepProg</a>.</p>





  
  

  242
  
</div>





  
  

  243
  
<div class="section" id="contribute">





  
  

  244
  
<h2>Contribute<a class="headerlink" href="#contribute" title="Permalink to this headline">¶</a></h2>





  
  

  245
  
<ul class="simple">





  
  

  246
  
<li><p>Issue Tracker: github.com/lanagarmire/DeepProg/issues</p></li>





  
  

  247
  
<li><p>Source Code: github.com/lanagarmire/DeepProg</p></li>





  
  

  248
  
</ul>





  
  

  249
  
</div>





  
  

  250
  
<div class="section" id="support">





  
  

  251
  
<h2>Support<a class="headerlink" href="#support" title="Permalink to this headline">¶</a></h2>





  
  

  252
  
<p>If you are having issues, please let us know.





  
  

  253
  
You can reach us using the following email address:</p>





  
  

  254
  
<p>Olivier Poirion, Ph.D.





  
  

  255
  
<a class="reference external" href="mailto:o&#46;poirion&#37;&#52;&#48;gmail&#46;com">o<span>&#46;</span>poirion<span>&#64;</span>gmail<span>&#46;</span>com</a></p>





  
  

  256
  
</div>





  
  

  257
  
<div class="section" id="citation">





  
  

  258
  
<h2>Citation<a class="headerlink" href="#citation" title="Permalink to this headline">¶</a></h2>





  
  

  259
  
<p>This package refers to our preprint paper: [Multi-omics-based pan-cancer prognosis prediction using an ensemble of deep-learning and machine-learning models](<a class="reference external" href="https://www.medrxiv.org/content/10.1101/19010082v1">https://www.medrxiv.org/content/10.1101/19010082v1</a>)</p>





  
  

  260
  
</div>





  
  

  261
  
<div class="section" id="license">





  
  

  262
  
<h2>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h2>





  
  

  263
  
<p>The project is licensed under the MIT license.</p>





  
  

  264
  
</div>





  
  

  265
  
</div>





  
  

  266
  





  
  

  267
  





  
  

  268
  
           </div>





  
  

  269
  
           





  
  

  270
  
          </div>





  
  

  271
  
          <footer>





  
  

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





  
  

  273
  
        <a href="installation.html" class="btn btn-neutral float-right" title="Installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>





  
  

  274
  
    </div>





  
  

  275
  





  
  

  276
  
  <hr/>





  
  

  277
  





  
  

  278
  
  <div role="contentinfo">





  
  

  279
  
    <p>





  
  

  280
  
        &#169; Copyright 2019, Olivier Poirion.





  
  

  281
  





  
  

  282
  
    </p>





  
  

  283
  
  </div>





  
  

  284
  
    





  
  

  285
  
    





  
  

  286
  
    





  
  

  287
  
    Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a





  
  

  288
  
    





  
  

  289
  
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>





  
  

  290
  
    





  
  

  291
  
    provided by <a href="https://readthedocs.org">Read the Docs</a>. 





  
  

  292
  





  
  

  293
  
</footer>





  
  

  294
  
        </div>





  
  

  295
  
      </div>





  
  

  296
  





  
  

  297
  
    </section>





  
  

  298
  





  
  

  299
  
  </div>





  
  

  300
  
  





  
  

  301
  





  
  

  302
  
  <script type="text/javascript">





  
  

  303
  
      jQuery(function () {





  
  

  304
  
          SphinxRtdTheme.Navigation.enable(true);





  
  

  305
  
      });





  
  

  306
  
  </script>





  
  

  307
  





  
  

  308
  
  





  
  

  309
  
  





  
  

  310
  
    





  
  

  311
  
   





  
  

  312
  





  
  

  313
  
</body>





  
  

  314
  
</html>