Preparing the code for the first release.

Author: aslucki

Makefile

@@ -1,6 +1,12 @@
-.PHONY: build, dev, test
+.PHONY: build, dev, test, clean
 IMAGE_NAME=wildnlp
 
+clean:
+	rm -rf build
+	rm -rf dist
+	rm -rf wild_nlp.egg-info
+	rm -rf .pytest_cache
+
 build:
 	docker build -t $(IMAGE_NAME) .
 

docs/build/doctrees/aspects.doctree

@@ -151,9 +151,18 @@ <h1>Source code for wildnlp.aspects.utils</h1><div class="highlight"><pre>
 <div class="viewcode-block" id="compose"><a class="viewcode-back" href="../../../aspects.html#wildnlp.aspects.utils.compose">[docs]</a><span class="k">def</span> <span class="nf">compose</span><span class="p">(</span><span class="o">*</span><span class="n">functions</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;Chains multiple aspects into a single function.</span>
 
-<span class="sd">    :param functions: an arbitrary object(s) of the Callable instance.</span>
+<span class="sd">    :param functions: Object(s) of the Callable instance.</span>
 
 <span class="sd">    :return: chained function</span>
+
+<span class="sd">    Example::</span>
+
+<span class="sd">        from wildnlp.aspects.utils import compose</span>
+<span class="sd">        from wildnlp.aspects import Swap, QWERTY</span>
+
+<span class="sd">        composed_aspect = compose(Swap(), QWERTY())</span>
+<span class="sd">        modified_text = composed_aspect(&#39;Text to corrupt&#39;)</span>
+<span class="sd">        </span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="k">return</span> <span class="n">functools</span><span class="o">.</span><span class="n">reduce</span><span class="p">(</span><span class="k">lambda</span> <span class="n">f</span><span class="p">,</span> <span class="n">g</span><span class="p">:</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">g</span><span class="p">(</span><span class="n">f</span><span class="p">(</span><span class="n">x</span><span class="p">)),</span>
                             <span class="n">functions</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="p">)</span></div>

docs/build/doctrees/environment.pickle

@@ -226,12 +226,20 @@ <h2>Base class<a class="headerlink" href="#base-class" title="Permalink to this
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>functions</strong> – an arbitrary object(s) of the Callable instance.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>functions</strong> – Object(s) of the Callable instance.</td>
 </tr>
 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">chained function</td>
 </tr>
 </tbody>
 </table>
+<p>Example:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">wildnlp.aspects.utils</span> <span class="k">import</span> <span class="n">compose</span>
+<span class="kn">from</span> <span class="nn">wildnlp.aspects</span> <span class="k">import</span> <span class="n">Swap</span><span class="p">,</span> <span class="n">QWERTY</span>
+
+<span class="n">composed_aspect</span> <span class="o">=</span> <span class="n">compose</span><span class="p">(</span><span class="n">Swap</span><span class="p">(),</span> <span class="n">QWERTY</span><span class="p">())</span>
+<span class="n">modified_text</span> <span class="o">=</span> <span class="n">composed_aspect</span><span class="p">(</span><span class="s1">&#39;Text to corrupt&#39;</span><span class="p">)</span>
+</pre></div>
+</div>
 </dd></dl>
 
 </div>

docs/build/html/_modules/wildnlp/aspects/utils.html

@@ -8,18 +8,19 @@
 
 setup(
     name="wild-nlp",
-    version="0.0.3",
+    version="1.0.0",
     author="Dominika Basaj, Barbara Rychalska, Alicja Gosiewska, Adam Słucki",
     author_email="adam.slucki@gmail.com",
     description=("Text aspects for nlp models"),
     license="BSD",
     url="https://github.com/MI2DataLab/WildNLP",
     packages=find_packages(),
+    include_package_data=True,
     long_description=long_description,
     long_description_content_type="text/markdown",
     classifiers=[
-        "Development Status :: 3 - Alpha",
-        "Topic :: Utilities",
+        "Development Status :: 4 - Beta",
+        "Topic :: Text Processing",
         "License :: OSI Approved :: BSD License",
     ],
     install_requires=[

docs/build/html/aspects.html

@@ -16,6 +16,9 @@ def test_advanced():
 
     assert 'the' not in modified.split()
 
+    aspect = Articles(swap_probability=230, seed=42)
+    assert aspect._swap_probability <= 1
+
 
 def test_multiple_sentences():
     sentences = 'This is a dollar sign - $. '\

docs/build/html/searchindex.js

@@ -19,6 +19,12 @@ def __init__(self, swap_probability=0.5, seed=42):
         """
 
         self._articles = ['a', 'an', 'the', '']
+
+        if swap_probability > 1 or swap_probability < 0:
+            swap_probability = 0.5
+            print('swap_probability should be in range (0,1), '
+                  'defaults to 0.5.')
+
         self._swap_probability = swap_probability
         random.seed(seed)
 

setup.py

@@ -23,7 +23,7 @@ def _tokenize(sentence):
 
         :return: List of tokens.
         """
-        return re.findall(r"[\w\'\-()]+|[^\s\w]", sentence)
+        return re.findall(r"[\w\'\-()*]+|[^\s\w]", sentence)
 
     @staticmethod
     def _detokenize(tokens):