blob: ff9f1b8d866f9527647c6386e41b1ab8ffe56d89 [file] [log] [blame]
<!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>Welcome to Apache Marvin-AI’s documentation! &mdash; Apache Marvin-AI 0.0.5 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<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/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Overview" href="pages/overview-marvin.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"> Apache Marvin-AI
</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">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="pages/overview-marvin.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="pages/main-components.html">Main Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="pages/install-marvin.html">Install Apache Marvin-AI</a></li>
<li class="toctree-l1"><a class="reference internal" href="pages/create-engine.html">Creating a New Engine</a></li>
<li class="toctree-l1"><a class="reference internal" href="pages/existing-engine.html">Working in an Existent Engine</a></li>
<li class="toctree-l1"><a class="reference internal" href="pages/features.html">Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="pages/architecture.html">Architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="pages/community.html">Community</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="#">Apache Marvin-AI</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="#">Docs</a> &raquo;</li>
<li>Welcome to Apache Marvin-AI’s 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">
<div class="section" id="welcome-to-apache-marvin-ai-s-documentation">
<h1>Welcome to Apache Marvin-AI’s documentation!<a class="headerlink" href="#welcome-to-apache-marvin-ai-s-documentation" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="pages/overview-marvin.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="pages/main-components.html">Main Components</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pages/main-components.html#dasfe">DASFE</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pages/install-marvin.html">Install Apache Marvin-AI</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pages/install-marvin.html#ubuntu-install">Ubuntu Install</a></li>
<li class="toctree-l2"><a class="reference internal" href="pages/install-marvin.html#macos-install">MacOS Install</a></li>
<li class="toctree-l2"><a class="reference internal" href="pages/install-marvin.html#docker-install">Docker Install</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pages/create-engine.html">Creating a New Engine</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pages/create-engine.html#creating-a-iris-flower-classification-engine-example">Creating a Iris Flower Classification Engine example</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pages/existing-engine.html">Working in an Existent Engine</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pages/existing-engine.html#running-a-example-engine">Running a example engine</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pages/features.html">Features</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pages/features.html#toolbox-cli">Toolbox CLI</a></li>
<li class="toctree-l2"><a class="reference internal" href="pages/features.html#engine-cli">Engine CLI</a></li>
<li class="toctree-l2"><a class="reference internal" href="pages/features.html#setting-environmental-variables">Setting Environmental Variables</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pages/architecture.html">Architecture</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pages/architecture.html#platform-concept-map-high-level-integration">Platform Concept Map (High Level Integration)</a></li>
<li class="toctree-l2"><a class="reference internal" href="pages/architecture.html#quality-attributes">Quality Attributes</a></li>
<li class="toctree-l2"><a class="reference internal" href="pages/architecture.html#architectural-tactics">Architectural Tactics</a></li>
<li class="toctree-l2"><a class="reference internal" href="pages/architecture.html#dasfe">DASFE</a></li>
<li class="toctree-l2"><a class="reference internal" href="pages/architecture.html#context-diagram">Context Diagram</a></li>
<li class="toctree-l2"><a class="reference internal" href="pages/architecture.html#execution-flow">Execution Flow</a></li>
<li class="toctree-l2"><a class="reference internal" href="pages/architecture.html#executor-and-engine">Executor and Engine</a></li>
<li class="toctree-l2"><a class="reference internal" href="pages/architecture.html#cluster-admin">Cluster Admin</a></li>
<li class="toctree-l2"><a class="reference internal" href="pages/architecture.html#deployment-diagram">Deployment Diagram</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pages/community.html">Community</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pages/community.html#github">GitHub</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
</ul>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="pages/overview-marvin.html" class="btn btn-neutral float-right" title="Overview" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
</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">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>