mirror of
https://github.com/JHUAPL/PINE.git
synced 2026-01-09 12:37:59 -05:00
This includes two main features: 1. Add/fix status/train/predict endpoints for pipelines. 2. Add OpenAPI specification for backend API.
247 lines
17 KiB
HTML
247 lines
17 KiB
HTML
|
|
|
|
<!doctype html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>pine.backend — pine documentation</title>
|
|
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
|
<link rel="stylesheet" href="../../../_static/bizstyle.css" type="text/css" />
|
|
<link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css" />
|
|
|
|
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
|
<script src="../../../_static/jquery.js"></script>
|
|
<script src="../../../_static/underscore.js"></script>
|
|
<script src="../../../_static/doctools.js"></script>
|
|
<script src="../../../_static/bizstyle.js"></script>
|
|
<link rel="index" title="Index" href="../../../genindex.html" />
|
|
<link rel="search" title="Search" href="../../../search.html" />
|
|
<link rel="next" title="pine.backend.admin" href="admin/index.html" />
|
|
<link rel="prev" title="pine" href="../index.html" />
|
|
<meta name="viewport" content="width=device-width,initial-scale=1.0" />
|
|
<!--[if lt IE 9]>
|
|
<script src="_static/css3-mediaqueries.js"></script>
|
|
<![endif]-->
|
|
</head><body>
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="../../../genindex.html" title="General Index"
|
|
accesskey="I">index</a></li>
|
|
<li class="right" >
|
|
<a href="../../../py-modindex.html" title="Python Module Index"
|
|
>modules</a> |</li>
|
|
<li class="right" >
|
|
<a href="admin/index.html" title="pine.backend.admin"
|
|
accesskey="N">next</a> |</li>
|
|
<li class="right" >
|
|
<a href="../index.html" title="pine"
|
|
accesskey="P">previous</a> |</li>
|
|
<li class="nav-item nav-item-0"><a href="../../../index.html">pine documentation</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="../../index.html" >API Reference</a> »</li>
|
|
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine</span></code></a> »</li>
|
|
<li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend</span></code></a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body" role="main">
|
|
|
|
<div class="section" id="module-pine.backend">
|
|
<span id="pine-backend"></span><h1><a class="reference internal" href="#module-pine.backend" title="pine.backend"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend</span></code></a><a class="headerlink" href="#module-pine.backend" title="Permalink to this headline">¶</a></h1>
|
|
<div class="section" id="subpackages">
|
|
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="admin/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.admin</span></code></a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="admin/bp/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.admin.bp</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="annotations/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.annotations</span></code></a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="annotations/bp/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.annotations.bp</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="api/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.api</span></code></a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="api/bp/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.api.bp</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="auth/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.auth</span></code></a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="auth/bp/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.auth.bp</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="auth/eve/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.auth.eve</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="auth/oauth/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.auth.oauth</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="auth/password/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.auth.password</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="auth/vegas/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.auth.vegas</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="collections/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.collections</span></code></a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="collections/bp/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.collections.bp</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="data/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.data</span></code></a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="data/bp/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.data.bp</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="data/service/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.data.service</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="data/users/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.data.users</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="documents/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.documents</span></code></a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="documents/bp/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.documents.bp</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="job_manager/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.job_manager</span></code></a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="job_manager/service/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.job_manager.service</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="pineiaa/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.pineiaa</span></code></a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="pineiaa/bratiaa/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.pineiaa.bratiaa</span></code></a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="pineiaa/bratiaa/agree/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.pineiaa.bratiaa.agree</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pineiaa/bratiaa/agree_cli/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.pineiaa.bratiaa.agree_cli</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pineiaa/bratiaa/evaluation/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.pineiaa.bratiaa.evaluation</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pineiaa/bratiaa/iaa_service/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.pineiaa.bratiaa.iaa_service</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pineiaa/bratiaa/utils/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.pineiaa.bratiaa.utils</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="pineiaa/bp/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.pineiaa.bp</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="pipelines/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.pipelines</span></code></a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="pipelines/bp/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.pipelines.bp</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="shared/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.shared</span></code></a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="shared/config/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.shared.config</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="shared/transform/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.shared.transform</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="submodules">
|
|
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="app/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.app</span></code></a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="config/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.config</span></code></a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cors/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.cors</span></code></a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="log/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.log</span></code></a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="models/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.models</span></code></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="package-contents">
|
|
<h2>Package Contents<a class="headerlink" href="#package-contents" title="Permalink to this headline">¶</a></h2>
|
|
<div class="section" id="functions">
|
|
<h3>Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h3>
|
|
<table class="longtable docutils align-default">
|
|
<colgroup>
|
|
<col style="width: 10%" />
|
|
<col style="width: 90%" />
|
|
</colgroup>
|
|
<tbody>
|
|
<tr class="row-odd"><td><p><a class="reference internal" href="#pine.backend.create_app" title="pine.backend.create_app"><code class="xref py py-obj docutils literal notranslate"><span class="pre">create_app</span></code></a>(test_config=None)</p></td>
|
|
<td><p></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="py function">
|
|
<dt id="pine.backend.create_app">
|
|
<code class="sig-prename descclassname"><span class="pre">pine.backend.</span></code><code class="sig-name descname"><span class="pre">create_app</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">test_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pine.backend.create_app" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py data">
|
|
<dt id="pine.backend.VERSION">
|
|
<code class="sig-prename descclassname"><span class="pre">pine.backend.</span></code><code class="sig-name descname"><span class="pre">VERSION</span></code><a class="headerlink" href="#pine.backend.VERSION" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py data">
|
|
<dt id="pine.backend.__version__">
|
|
<code class="sig-prename descclassname"><span class="pre">pine.backend.</span></code><code class="sig-name descname"><span class="pre">__version__</span></code><a class="headerlink" href="#pine.backend.__version__" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="clearer"></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
<div class="sphinxsidebarwrapper">
|
|
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
|
<ul>
|
|
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend</span></code></a><ul>
|
|
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
|
|
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
|
<li><a class="reference internal" href="#package-contents">Package Contents</a><ul>
|
|
<li><a class="reference internal" href="#functions">Functions</a><ul>
|
|
<li><a class="reference internal" href="#pine.backend.create_app">create_app</a></li>
|
|
<li><a class="reference internal" href="#pine.backend.VERSION">VERSION</a></li>
|
|
<li><a class="reference internal" href="#pine.backend.__version__">__version__</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
<h4>Previous topic</h4>
|
|
<p class="topless"><a href="../index.html"
|
|
title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine</span></code></a></p>
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="admin/index.html"
|
|
title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.admin</span></code></a></p>
|
|
<div role="note" aria-label="source link">
|
|
<h3>This Page</h3>
|
|
<ul class="this-page-menu">
|
|
<li><a href="../../../_sources/autoapi/pine/backend/index.rst.txt"
|
|
rel="nofollow">Show Source</a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="searchbox" style="display: none" role="search">
|
|
<h3 id="searchlabel">Quick search</h3>
|
|
<div class="searchformwrapper">
|
|
<form class="search" action="../../../search.html" method="get">
|
|
<input type="text" name="q" aria-labelledby="searchlabel" />
|
|
<input type="submit" value="Go" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
<script>$('#searchbox').show(0);</script>
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="../../../genindex.html" title="General Index"
|
|
>index</a></li>
|
|
<li class="right" >
|
|
<a href="../../../py-modindex.html" title="Python Module Index"
|
|
>modules</a> |</li>
|
|
<li class="right" >
|
|
<a href="admin/index.html" title="pine.backend.admin"
|
|
>next</a> |</li>
|
|
<li class="right" >
|
|
<a href="../index.html" title="pine"
|
|
>previous</a> |</li>
|
|
<li class="nav-item nav-item-0"><a href="../../../index.html">pine documentation</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="../../index.html" >API Reference</a> »</li>
|
|
<li class="nav-item nav-item-2"><a href="../index.html" ><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine</span></code></a> »</li>
|
|
<li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend</span></code></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="footer" role="contentinfo">
|
|
© Copyright (C) 2019 The Johns Hopkins University Applied Physics Laboratory LLC..
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.5.3.
|
|
</div>
|
|
</body>
|
|
</html> |