JHUAPL/PINE
1
0
Fork 0
mirror of https://github.com/JHUAPL/PINE.git synced 2026-01-09 12:37:59 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
d9cdcf17215db0d61cd86fc9724bcb2740377cae
PINE/docs/build/html/autoapi/index.html
Laura Glendenning d9cdcf1721 Updates from internal development branch. 
This includes two main features:

1. Add/fix status/train/predict endpoints for pipelines.
2. Add OpenAPI specification for backend API.
2021-08-04 11:38:21 -04:00

229 lines
19 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!doctype html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>API Reference &#8212; 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" href="pine/index.html" />
<link rel="prev" title="Welcome to pine’s documentation!" 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="pine/index.html" title="pine"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../index.html" title="Welcome to pine’s documentation!"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">pine documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">API Reference</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="api-reference">
<h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline"></a></h1>
<p>This page contains auto-generated API reference documentation <a class="footnote-reference brackets" href="#f1" id="id1">1</a>.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="pine/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine</span></code></a><ul>
<li class="toctree-l2"><a class="reference internal" href="pine/backend/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="pine/backend/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-l4"><a class="reference internal" href="pine/backend/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-l3"><a class="reference internal" href="pine/backend/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-l4"><a class="reference internal" href="pine/backend/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-l3"><a class="reference internal" href="pine/backend/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-l4"><a class="reference internal" href="pine/backend/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-l3"><a class="reference internal" href="pine/backend/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-l4"><a class="reference internal" href="pine/backend/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-l4"><a class="reference internal" href="pine/backend/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-l4"><a class="reference internal" href="pine/backend/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-l4"><a class="reference internal" href="pine/backend/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-l4"><a class="reference internal" href="pine/backend/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-l3"><a class="reference internal" href="pine/backend/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-l4"><a class="reference internal" href="pine/backend/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-l3"><a class="reference internal" href="pine/backend/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-l4"><a class="reference internal" href="pine/backend/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-l4"><a class="reference internal" href="pine/backend/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-l4"><a class="reference internal" href="pine/backend/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-l3"><a class="reference internal" href="pine/backend/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-l4"><a class="reference internal" href="pine/backend/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-l3"><a class="reference internal" href="pine/backend/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-l4"><a class="reference internal" href="pine/backend/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-l3"><a class="reference internal" href="pine/backend/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-l4"><a class="reference internal" href="pine/backend/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-l5"><a class="reference internal" href="pine/backend/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-l5"><a class="reference internal" href="pine/backend/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-l5"><a class="reference internal" href="pine/backend/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-l5"><a class="reference internal" href="pine/backend/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-l5"><a class="reference internal" href="pine/backend/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-l4"><a class="reference internal" href="pine/backend/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-l3"><a class="reference internal" href="pine/backend/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-l4"><a class="reference internal" href="pine/backend/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-l3"><a class="reference internal" href="pine/backend/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-l4"><a class="reference internal" href="pine/backend/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-l4"><a class="reference internal" href="pine/backend/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>
<li class="toctree-l3"><a class="reference internal" href="pine/backend/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-l3"><a class="reference internal" href="pine/backend/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-l3"><a class="reference internal" href="pine/backend/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-l3"><a class="reference internal" href="pine/backend/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-l3"><a class="reference internal" href="pine/backend/models/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.models</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pine/client/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.client</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="pine/client/client/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.client.client</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pine/client/exceptions/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.client.exceptions</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pine/client/log/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.client.log</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pine/client/models/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.client.models</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pine/client/password/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.client.password</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pine/pipelines/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.pipelines</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="pine/pipelines/app/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.pipelines.app</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pine/pipelines/app/listener/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.pipelines.app.listener</span></code></a><ul>
<li class="toctree-l5"><a class="reference internal" href="pine/pipelines/app/listener/main/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.pipelines.app.listener.main</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="pine/pipelines/app/listener/service_listener/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.pipelines.app.listener.service_listener</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pine/pipelines/shared/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.pipelines.shared</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pine/pipelines/shared/config/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.pipelines.shared.config</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pine/pipelines/shared/transform/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.pipelines.shared.transform</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pine/pipelines/EveClient/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.pipelines.EveClient</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pine/pipelines/NERWrapper/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.pipelines.NERWrapper</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pine/pipelines/NER_API/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.pipelines.NER_API</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pine/pipelines/RankingFunctions/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.pipelines.RankingFunctions</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pine/pipelines/corenlp_NER_pipeline/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.pipelines.corenlp_NER_pipeline</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pine/pipelines/opennlp_NER_pipeline/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.pipelines.opennlp_NER_pipeline</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pine/pipelines/pipeline/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.pipelines.pipeline</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pine/pipelines/pmap_ner/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.pipelines.pmap_ner</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pine/pipelines/run_service/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.pipelines.run_service</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pine/pipelines/spacy_NER_pipeline/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.pipelines.spacy_NER_pipeline</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<dl class="footnote brackets">
<dt class="label" id="f1"><span class="brackets"><a class="fn-backref" href="#id1">1</a></span></dt>
<dd><p>Created with <a class="reference external" href="https://github.com/readthedocs/sphinx-autoapi">sphinx-autoapi</a></p>
</dd>
</dl>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="../index.html"
title="previous chapter">Welcome to pine’s documentation!</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="pine/index.html"
title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine</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/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="pine/index.html" title="pine"
>next</a> |</li>
<li class="right" >
<a href="../index.html" title="Welcome to pine’s documentation!"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">pine documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">API Reference</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; 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>
Reference in New Issue View Git Blame Copy Permalink