ribesstefano's picture
Added all required files for documentation + Updated tests for embeddings
2f0863a
raw
history blame
16.3 kB
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>PROTAC-Degradation-Predictor documentation &mdash; PROTAC-Degradation-Predictor v1.0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=d29a5c0e"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="protac_degradation_predictor" href="source/modules.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home">
PROTAC-Degradation-Predictor
</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" aria-label="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="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="source/modules.html">protac_degradation_predictor</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">PROTAC-Degradation-Predictor</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">PROTAC-Degradation-Predictor documentation</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="protac-degradation-predictor-documentation">
<h1>PROTAC-Degradation-Predictor documentation<a class="headerlink" href="#protac-degradation-predictor-documentation" title="Link to this heading"></a></h1>
<p>Add your content using <code class="docutils literal notranslate"><span class="pre">reStructuredText</span></code> syntax. See the
<a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html">reStructuredText</a>
documentation for details.</p>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="source/modules.html">protac_degradation_predictor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="source/protac_degradation_predictor.html">protac_degradation_predictor package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="source/protac_degradation_predictor.html#subpackages">Subpackages</a><ul>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.optuna.html">protac_degradation_predictor.optuna package</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="source/protac_degradation_predictor.html#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="source/protac_degradation_predictor.html#module-protac_degradation_predictor.config">protac_degradation_predictor.config module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.config.Config"><code class="docutils literal notranslate"><span class="pre">Config</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="source/protac_degradation_predictor.html#module-protac_degradation_predictor.data_utils">protac_degradation_predictor.data_utils module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.data_utils.avail_e3_ligases"><code class="docutils literal notranslate"><span class="pre">avail_e3_ligases()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.data_utils.avail_cell_lines"><code class="docutils literal notranslate"><span class="pre">avail_cell_lines()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.data_utils.avail_uniprots"><code class="docutils literal notranslate"><span class="pre">avail_uniprots()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.data_utils.get_fingerprint"><code class="docutils literal notranslate"><span class="pre">get_fingerprint()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.data_utils.is_active"><code class="docutils literal notranslate"><span class="pre">is_active()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.data_utils.load_curated_dataset"><code class="docutils literal notranslate"><span class="pre">load_curated_dataset()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="source/protac_degradation_predictor.html#module-protac_degradation_predictor.optuna_utils">protac_degradation_predictor.optuna_utils module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.optuna_utils.get_dataframe_stats"><code class="docutils literal notranslate"><span class="pre">get_dataframe_stats()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.optuna_utils.get_majority_vote_metrics"><code class="docutils literal notranslate"><span class="pre">get_majority_vote_metrics()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.optuna_utils.get_suggestion"><code class="docutils literal notranslate"><span class="pre">get_suggestion()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.optuna_utils.pytorch_model_objective"><code class="docutils literal notranslate"><span class="pre">pytorch_model_objective()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.optuna_utils.hyperparameter_tuning_and_training"><code class="docutils literal notranslate"><span class="pre">hyperparameter_tuning_and_training()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="source/protac_degradation_predictor.html#module-protac_degradation_predictor.optuna_utils_xgboost">protac_degradation_predictor.optuna_utils_xgboost module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.optuna_utils_xgboost.get_confidence_scores"><code class="docutils literal notranslate"><span class="pre">get_confidence_scores()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.optuna_utils_xgboost.train_and_evaluate_xgboost"><code class="docutils literal notranslate"><span class="pre">train_and_evaluate_xgboost()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.optuna_utils_xgboost.xgboost_model_objective"><code class="docutils literal notranslate"><span class="pre">xgboost_model_objective()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.optuna_utils_xgboost.xgboost_hyperparameter_tuning_and_training"><code class="docutils literal notranslate"><span class="pre">xgboost_hyperparameter_tuning_and_training()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="source/protac_degradation_predictor.html#module-protac_degradation_predictor.protac_dataset">protac_degradation_predictor.protac_dataset module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.protac_dataset.PROTAC_Dataset"><code class="docutils literal notranslate"><span class="pre">PROTAC_Dataset</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.protac_dataset.get_datasets"><code class="docutils literal notranslate"><span class="pre">get_datasets()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.protac_dataset.PROTAC_DataModule"><code class="docutils literal notranslate"><span class="pre">PROTAC_DataModule</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="source/protac_degradation_predictor.html#module-protac_degradation_predictor.protac_degradation_predictor">protac_degradation_predictor.protac_degradation_predictor module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.protac_degradation_predictor.get_protac_active_proba"><code class="docutils literal notranslate"><span class="pre">get_protac_active_proba()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.protac_degradation_predictor.is_protac_active"><code class="docutils literal notranslate"><span class="pre">is_protac_active()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.protac_degradation_predictor.get_protac_embedding"><code class="docutils literal notranslate"><span class="pre">get_protac_embedding()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="source/protac_degradation_predictor.html#module-protac_degradation_predictor.pytorch_models">protac_degradation_predictor.pytorch_models module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.pytorch_models.PROTAC_Predictor"><code class="docutils literal notranslate"><span class="pre">PROTAC_Predictor</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.pytorch_models.PROTAC_Model"><code class="docutils literal notranslate"><span class="pre">PROTAC_Model</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.pytorch_models.get_confidence_scores"><code class="docutils literal notranslate"><span class="pre">get_confidence_scores()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.pytorch_models.train_model"><code class="docutils literal notranslate"><span class="pre">train_model()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.pytorch_models.evaluate_model"><code class="docutils literal notranslate"><span class="pre">evaluate_model()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.pytorch_models.load_model"><code class="docutils literal notranslate"><span class="pre">load_model()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="source/protac_degradation_predictor.html#module-protac_degradation_predictor.sklearn_models">protac_degradation_predictor.sklearn_models module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.sklearn_models.train_sklearn_model"><code class="docutils literal notranslate"><span class="pre">train_sklearn_model()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.sklearn_models.suggest_random_forest"><code class="docutils literal notranslate"><span class="pre">suggest_random_forest()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.sklearn_models.suggest_logistic_regression"><code class="docutils literal notranslate"><span class="pre">suggest_logistic_regression()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.sklearn_models.suggest_svc"><code class="docutils literal notranslate"><span class="pre">suggest_svc()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="source/protac_degradation_predictor.html#protac_degradation_predictor.sklearn_models.suggest_gradient_boosting"><code class="docutils literal notranslate"><span class="pre">suggest_gradient_boosting()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="source/protac_degradation_predictor.html#module-protac_degradation_predictor">Module contents</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="source/modules.html" class="btn btn-neutral float-right" title="protac_degradation_predictor" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024, Stefano Ribes.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>