This repository has been archived by the owner on Jun 12, 2021. It is now read-only.
docs
Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
parent directory.. | ||||
<!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>practNLPTools-lite — practNLPTools-lite __version__ = '0.3.4' documentation</title>
<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="Installation" href="installation.html" />
<link rel="prev" title="Welcome to practNLPTools-lite’s documentation!" href="index.html" />
<script src="_static/js/modernizr.min.js"></script>
</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"> practNLPTools-lite
</a>
<div class="version">
__version__ = '0.3.4'
</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" />
<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">
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">practNLPTools-lite</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#quickstart">QuickStart</a></li>
<li class="toctree-l2"><a class="reference internal" href="#downlarding-stanford-parser-jar">Downlarding Stanford Parser JAR</a></li>
<li class="toctree-l2"><a class="reference internal" href="#running-predefine-examples-sentences">Running Predefine Examples Sentences</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#example">Example</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#running-user-given-sentence">Running user given sentence</a></li>
<li class="toctree-l2"><a class="reference internal" href="#functionality">Functionality</a></li>
<li class="toctree-l2"><a class="reference internal" href="#future-work">Future work</a></li>
<li class="toctree-l2"><a class="reference internal" href="#features">Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#bench-mark-comparsion">Bench Mark comparsion</a></li>
<li class="toctree-l2"><a class="reference internal" href="#credits">Credits</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="cli.html">CLI</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="environment.html">Environment</a></li>
<li class="toctree-l1"><a class="reference internal" href="issues.html">Issues</a></li>
<li class="toctree-l1"><a class="reference internal" href="stanford_installing_issues.html">Stanford Parser</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">CHANGELOG</a></li>
<li class="toctree-l1"><a class="reference internal" href="authors.html">Credits</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</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="index.html">practNLPTools-lite</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="index.html">Docs</a> »</li>
<li>practNLPTools-lite</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/readme.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="practnlptools-lite">
<h1>practNLPTools-lite<a class="headerlink" href="#practnlptools-lite" title="Permalink to this headline">¶</a></h1>
<p><strong>pntl.db</strong> module have moved as new python package.</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">CLI is only for example purpose don’t use for long running jobs.</p>
</div>
<p>Creating practNLPTools in lite mode.[ get the old coding in <a class="reference external" href="https://github.com/jawahar273/practNLPTools-lite/tree/dev">devbranch</a> or oldest stable code <a class="reference external" href="https://github.com/jawahar273/practNLPTools-lite/tree/pyup-update-pytest-3.2.2-to-3.2.3">properbranch</a>]</p>
<p><img alt="Author" src="https://img.shields.io/badge/Author-jawahar-blue.svg" /> <img alt="python_version" src="https://img.shields.io/badge/python3+-only-red.svg" /></p>
<p><a class="reference external" href="https://travis-ci.org/jawahar273/practNLPTools"><img alt="Build Status" src="https://travis-ci.org/jawahar273/practNLPTools.svg?branch=master" /></a> - on click this built this might take you to build of
<a class="reference external" href="https://github.com/jawahar273/practNLPTools-lite">practNLPTools</a> which is testing ground for this repository so don’t
worry.</p>
<p>Practical Natural Language Processing Tools for Humans.
practNLPTools is a pythonic library over <a class="reference external" href="http://ronan.collobert.com/senna/">SENNA</a> and Stanford
Dependency Extractor.</p>
<table border="1" class="docutils">
<colgroup>
<col width="50%" />
<col width="50%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">name</th>
<th class="head">status</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>PyPi</td>
<td><a class="reference external" href="https://pypi.python.org/pypi/pntl"><img alt="pypi status" src="https://img.shields.io/pypi/v/practNLPTools-lite.svg" /></a></td>
</tr>
<tr class="row-odd"><td>travis</td>
<td><a class="reference external" href="https://travis-ci.org/jawahar273/practNLPTools-lite"><img alt="travis status" src="https://img.shields.io/travis/jawahar273/practNLPTools-lite.svg" /></a></td>
</tr>
<tr class="row-even"><td>Documentation</td>
<td><a class="reference external" href="https://pntl.readthedocs.io/en/latest/?badge=latest"><img alt="Documentation Status" src="https://readthedocs.org/projects/pntl/badge/?version=latest" /></a></td>
</tr>
<tr class="row-odd"><td>dependency</td>
<td><a class="reference external" href="https://pyup.io/repos/github/jawahar273/practNLPTools-lite/"><img alt="Updates" src="https://pyup.io/repos/github/jawahar273/practNLPTools-lite/shield.svg" /></a></td>
</tr>
<tr class="row-even"><td>blocker Pyupbot</td>
<td><a class="reference external" href="https://pyup.io/repos/github/jawahar273/practNLPTools-lite/"><img alt="Python 3" src="https://pyup.io/repos/github/jawahar273/practNLPTools-lite/python-3-shield.svg" /></a></td>
</tr>
<tr class="row-odd"><td>FOSSA</td>
<td><a class="reference external" href="https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fjawahar273%2FpractNLPTools-lite?ref=badge_small"><img alt="FOSSA Status" src="https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fjawahar273%2FpractNLPTools-lite.svg?type=small" /></a></td>
</tr>
</tbody>
</table>
<ul class="simple">
<li>Documentation <a class="reference external" href="https://pntl.readthedocs.io">docs1</a></li>
</ul>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">After version 0.3.0+ pntl should able to store the result into
database for later usage.</p>
</div>
<div class="section" id="quickstart">
<h2>QuickStart<a class="headerlink" href="#quickstart" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="downlarding-stanford-parser-jar">
<h2>Downlarding Stanford Parser JAR<a class="headerlink" href="#downlarding-stanford-parser-jar" title="Permalink to this headline">¶</a></h2>
<p>To downlard the stanford-parser from github automatically and placing them inside the install direction.</p>
<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pntl</span> <span class="o">-</span><span class="n">I</span> <span class="n">true</span>
<span class="c1"># downlards required file from github.</span>
</pre></div>
</div>
</div>
<div class="section" id="running-predefine-examples-sentences">
<h2>Running Predefine Examples Sentences<a class="headerlink" href="#running-predefine-examples-sentences" title="Permalink to this headline">¶</a></h2>
<p>To run predefine example in batch mode(which has more than one list of examples).</p>
<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pntl</span> <span class="o">-</span><span class="n">SE</span> <span class="n">home</span><span class="o">/</span><span class="n">user</span><span class="o">/</span><span class="n">senna</span> <span class="o">-</span><span class="n">B</span> <span class="n">true</span>
</pre></div>
</div>
<div class="section" id="example">
<h3>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h3>
<p>Batch mode means listed sentences.</p>
<p>..code:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Example structure for predefine</span>
<span class="c1"># Sentences in the code.</span>
<span class="n">sentences</span> <span class="o">=</span> <span class="p">[</span>
<span class="s2">"This is line 1"</span><span class="p">,</span>
<span class="s2">"This is line 2"</span><span class="p">,</span>
<span class="p">]</span>
</pre></div>
</div>
<p>To run predefine example in non batch mode.</p>
<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pntl</span> <span class="o">-</span><span class="n">SE</span> <span class="n">home</span><span class="o">/</span><span class="n">user</span><span class="o">/</span><span class="n">senna</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="running-user-given-sentence">
<h2>Running user given sentence<a class="headerlink" href="#running-user-given-sentence" title="Permalink to this headline">¶</a></h2>
<p>To run user given example using <cite>-S</cite> is</p>
<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pntl</span> <span class="o">-</span><span class="n">SE</span> <span class="n">home</span><span class="o">/</span><span class="n">user</span><span class="o">/</span><span class="n">senna</span> <span class="o">-</span><span class="n">S</span> <span class="s1">'I am gonna make him an offer he can not refuse.'</span>
</pre></div>
</div>
</div>
<div class="section" id="functionality">
<h2>Functionality<a class="headerlink" href="#functionality" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>Semantic Role Labeling.</li>
<li>Syntactic Parsing.</li>
<li>Part of Speech Tagging (POS Tagging).</li>
<li>Named Entity Recognisation (NER).</li>
<li>Dependency Parsing.</li>
<li>Shallow Chunking.</li>
<li>Skip-gram(in-case).</li>
<li>find the senna path if is install in the system.</li>
<li>stanford parser and depPaser file into installed direction.</li>
</ul>
</div>
<div class="section" id="future-work">
<h2>Future work<a class="headerlink" href="#future-work" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>tag2file(new)</li>
<li>creating depParser for corresponding os environment</li>
<li>custome input format for stanford parser insted of tree format</li>
</ul>
</div>
<div class="section" id="features">
<h2>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h2>
<ol class="arabic simple">
<li>Fast: <a class="reference external" href="http://ronan.collobert.com/senna/">SENNA</a> is written is C. So it is Fast.</li>
<li>We use only dependency Extractor Component of Stanford Parser, which
takes in Syntactic Parse from SENNA and applies dependency
Extraction. So there is no need to load parsing models for Stanford
Parser, which takes time.</li>
<li>Easy to use.</li>
<li>Platform Supported - Windows, Linux and Mac</li>
<li>Automatic finds stanford parsing jar if it is present in install path[pntl].</li>
</ol>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">SENNA pipeline has a fixed maximum size of the sentences that it
can read. By default it is 1024 token/sentence. If you have larger
sentences, changing the MAX_SENTENCE_SIZE value in SENNA_main.c should beconsidered and your system specific binary should be rebuilt. Otherwise this could introduce misalignment errors.</p>
</div>
</div>
<div class="section" id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
<p><strong>Requires:</strong></p>
<blockquote>
<div><p>A computer with 500mb memory, Java Runtime Environment (1.7
preferably, works with 1.6 too, but didnt test.) installed and python.</p>
<p><strong>Linux:</strong></p>
<p>run:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">install</span>
</pre></div>
</div>
<p>windows:</p>
<p>run this commands as administrator:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">install</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="bench-mark-comparsion">
<h2>Bench Mark comparsion<a class="headerlink" href="#bench-mark-comparsion" title="Permalink to this headline">¶</a></h2>
<p>By using the <code class="docutils literal notranslate"><span class="pre">time</span></code> command in ubuntu on running the <code class="docutils literal notranslate"><span class="pre">testsrl.py</span></code> on
this <a class="reference external" href="https://github.com/jawahar273/SRLTagger">link</a> and along with <code class="docutils literal notranslate"><span class="pre">tools.py</span></code> on <code class="docutils literal notranslate"><span class="pre">pntl</span></code></p>
<table border="1" class="docutils">
<colgroup>
<col width="33%" />
<col width="33%" />
<col width="33%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head"> </th>
<th class="head">pntl</th>
<th class="head">NLTK-senna</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>at fist run</td>
<td> </td>
<td> </td>
</tr>
<tr class="row-odd"><td> </td>
<td>real 0m1.674s</td>
<td>real 0m2.484s</td>
</tr>
<tr class="row-even"><td> </td>
<td>user 0m1.564s</td>
<td>user 0m1.868s</td>
</tr>
<tr class="row-odd"><td> </td>
<td>sys 0m0.228s</td>
<td>sys 0m0.524s</td>
</tr>
<tr class="row-even"><td>at second run</td>
<td> </td>
<td> </td>
</tr>
<tr class="row-odd"><td> </td>
<td>real 0m1.245s</td>
<td>real 0m3.359s</td>
</tr>
<tr class="row-even"><td> </td>
<td>user 0m1.560s</td>
<td>user 0m2.016s</td>
</tr>
<tr class="row-odd"><td> </td>
<td>sys 0m0.152s</td>
<td>sys 0m1.168s</td>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">this bench mark may differt accouding to system’s working and to restult present here is exact same result in my system ububtu 4Gb RAM
and i3 process. If I find another good benchmark techinque then I will
change to it.</p>
</div>
</div>
<div class="section" id="credits">
<h2>Credits<a class="headerlink" href="#credits" title="Permalink to this headline">¶</a></h2>
<p>This package was created with <a class="reference external" href="https://github.com/audreyr/cookiecutter">Cookiecutter</a> and the <a class="reference external" href="https://github.com/audreyr/cookiecutter-pypackage">audreyr/cookiecutter-pypackage</a> project template.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="installation.html" class="btn btn-neutral float-right" title="Installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral" title="Welcome to practNLPTools-lite’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2017-2019, Jawahar S
</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" 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>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
