AbductiveLearning
/
ABLkit

 
			
							<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Quick Start &mdash; ABL 0.1.0 documentation</title>
      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  <!--[if lt IE 9]>
    <script src="../_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script src="../_static/jquery.js"></script>
        <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
        <script src="../_static/doctools.js"></script>
        <script src="../_static/sphinx_highlight.js"></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="MNISTadd" href="../Examples/MNISTadd.html" />
    <link rel="prev" title="Abductive Learning" href="Abductive%20Learning.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="../index.html" class="icon icon-home">
            ABL
          </a>
              <div class="version">
                0.1.0
              </div>
<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">Tutorial of ABL</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="Abductive%20Learning.html">Abductive Learning</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Quick Start</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#required-packages">Required packages</a></li>
<li class="toctree-l2"><a class="reference internal" href="#getting-and-installing-abl">Getting and installing ABL</a></li>
<li class="toctree-l2"><a class="reference internal" href="#a-quick-example">A quick example</a></li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Examples</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Examples/MNISTadd.html">MNISTadd</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="../index.html">ABL</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="../index.html" class="icon icon-home" aria-label="Home"></a></li>
      <li class="breadcrumb-item active">Quick Start</li>
      <li class="wy-breadcrumbs-aside">
            <a href="../_sources/ABL/Quick Start.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="quick-start">
<h1><a class="toc-backref" href="#id1" role="doc-backlink">Quick Start</a><a class="headerlink" href="#quick-start" title="Permalink to this heading"></a></h1>
<p>How to use</p>
<nav class="contents" id="table-of-contents">
<p class="topic-title">Table of Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#quick-start" id="id1">Quick Start</a></p>
<ul>
<li><p><a class="reference internal" href="#required-packages" id="id2">Required packages</a></p></li>
<li><p><a class="reference internal" href="#getting-and-installing-abl" id="id3">Getting and installing ABL</a></p></li>
<li><p><a class="reference internal" href="#a-quick-example" id="id4">A quick example</a></p></li>
</ul>
</li>
</ul>
</nav>
<section id="required-packages">
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Required packages</a><a class="headerlink" href="#required-packages" title="Permalink to this heading"></a></h2>
<p>This package requires the following packages:</p>
<ul class="simple">
<li><p>Python version above 3.x</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">numpy</span></code> <a class="reference external" href="http://www.numpy.org">http://www.numpy.org</a></p></li>
</ul>
<p>The easiest way to get these is to use
<a class="reference external" href="https://pypi.python.org/pypi/pip">pip</a> or
<a class="reference external" href="https://www.anaconda.com/what-is-anaconda/">conda</a> environment
manager. Typing the following command in your terminal will install all
required packages in your Python environment.</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>conda install numpy
</pre></div>
</div>
<p>or</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>pip install numpy
</pre></div>
</div>
</section>
<section id="getting-and-installing-abl">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Getting and installing ABL</a><a class="headerlink" href="#getting-and-installing-abl" title="Permalink to this heading"></a></h2>
<p>The easiest way to install ABL is to type <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">ABL</span></code> in you
terminal/command line.</p>
<p>If you want to install ABL by source code, download this project and
sequentially run following commands in your terminal/command line.</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>python setup.py build
<span class="gp">$ </span>python setup.py install
</pre></div>
</div>
</section>
<section id="a-quick-example">
<h2><a class="toc-backref" href="#id4" role="doc-backlink">A quick example</a><a class="headerlink" href="#a-quick-example" title="Permalink to this heading"></a></h2>
<p>Show an example.</p>
<p>More examples are available in the <strong>Example</strong> part.</p>
</section>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="Abductive%20Learning.html" class="btn btn-neutral float-left" title="Abductive Learning" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="../Examples/MNISTadd.html" class="btn btn-neutral float-right" title="MNISTadd" 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 Yu-Xuan Huang, Wen-Chao Hu, En-Hao Gao.</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>