Merge pull request #142 from artefactory/feature/cd

Feature/cd
artefactory · Feb 16, 2021 · 262e829 · 262e829
2 parents e0683a2 + 14b8e90
commit 262e829
Show file tree

Hide file tree

Showing 26 changed files with 117 additions and 408 deletions.
diff --git a/.github/workflows/ci_actions.yml → .github/workflows/ci.yml b/.github/workflows/ci_actions.yml → .github/workflows/ci.yml
@@ -38,7 +38,9 @@ jobs:
       - name: Install requirements
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements.txt
+          pip install -r requirements_dev.txt
+          pip install https://github.com/explosion/spacy-models/releases/download/en_core_web_sm-2.3.1/en_core_web_sm-2.3.1.tar.gz
+          pip install https://github.com/explosion/spacy-models/releases/download/fr_core_news_sm-2.3.0/fr_core_news_sm-2.3.0.tar.gz
 
       - name: Run pylint
         run: |

diff --git a/README.md b/README.md
@@ -88,7 +88,7 @@ print(text)
 # "dinner life recommend"
 ```
 
-Take a look at all the functions that are available [here](https://github.com/artefactory/NLPretext/tree/feature/readme/nlpretext) in the ```preprocess.py``` scripts in the different folders: basic, social, token.
+Take a look at all the functions that are available [here](https://github.com/artefactory/NLPretext/tree/master/nlpretext) in the ```preprocess.py``` scripts in the different folders: basic, social, token.
 
 
 # Individual Functions

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-0.9.1
+1.0.0
diff --git a/docs/conf.py b/docs/conf.py
@@ -31,17 +31,20 @@
 #
 import os
 import sys
+from pathlib import Path
+
 sys.path.insert(0, os.path.abspath('../'))
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'Nautilus_nlp'
+project = 'NLPretext'
 copyright = '2020, Artefact'
 author = 'Artefact'
 
-# The short X.Y version
-version = '0.1.0'
+with open(Path(__file__).resolve().parent.joinpath('../VERSION'), 'r') as fh:
+    version = fh.read()
+
 # The full version, including alpha/beta/rc tags
 release = ''
 
@@ -129,7 +132,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'Nautilus_nlpdoc'
+htmlhelp_basename = 'NLPretextdoc'
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -156,8 +159,8 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'Nautilus_nlp.tex', 'Nautilus\\_nlp Documentation',
-     'Robin Doumerc', 'manual'),
+    (master_doc, 'NLPretext.tex', 'NLPretext Documentation',
+     'Artefact', 'manual'),
 ]
 
 
@@ -166,7 +169,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'nautilus_nlp', 'Nautilus_nlp Documentation',
+    (master_doc, 'NLPretext', 'NLPretext Documentation',
      [author], 1)
 ]
 
@@ -177,8 +180,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'Nautilus_nlp', 'Nautilus_nlp Documentation',
-     author, 'Nautilus_nlp', 'One line description of project.',
+    (master_doc, 'NLPretext', 'NLPretext Documentation',
+     author, 'NLPretext', 'One line description of project.',
      'Miscellaneous'),
 ]
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,63 +1,57 @@
 
 
-Welcome to Nautilus_nlp's documentation!
+Welcome to NLPretext's documentation!
 ========================================
 
-The Nautilus NLP library aimed to be a meta-library to be used to help you get started on handling your NLP use-case.
+The NLPretext library aimed to be a meta-library to be used to help you get started on handling your NLP use-case preprocessing.
 
-This library can help you with:
 
-    1. Cleaning text data
-    2. Normalizing your dataset
-    3. Training automatically multiclass, multilabel classifier
-    4. Help you discover topics and cluster your data
+# Installation
 
+Beware, this package has been tested on Python **3.6** & **3.7** & **3.8**, and will probably not be working under python **2.7** as **Python2.7** EOL is scheduled for December 2019. 
 
-# Feature Request
+To install this library you should first clone the repository:
 
-As an Artefact user, you might be working on a NLP use case, and wish to use Nautilus.
+pip install nlpretext
 
- However, if you think Nautilus is lacking features that can be useful not only to your use case but also others, feel free to to fill up an issue with the label "Feature-request".
+This library uses Spacy as tokenizer. Current models supported are `en_core_web_sm` and `fr_core_news_sm`. If not installed, run the following commands:
 
- We will try to put it in the roadmap and implement it as soon as possible.
+pip install https://github.com/explosion/spacy-models/releases/download/en_core_web_sm-2.3.1/en_core_web_sm-2.3.1.tar.gz
 
-# Installation
+pip install https://github.com/explosion/spacy-models/releases/download/fr_core_news_sm-2.3.0/fr_core_news_sm-2.3.0.tar.gz
 
-Beware, this package has been tested on Python **3.6** & **3.7**, and will probably not be working under python **2.7** as **Python2.7** EOL is scheduled for December 2019. 
 
-To install this library you should first clone the repository:
 
-`git clone https://github.com/artefactory/nautilus_nlp/ && cd nautilus_nlp`
-
-**If you don't use the docker container, we strongly advise you to do these steps in a virtual environnement**
-
-First you need to install the required files:
+.. toctree::
+   :maxdepth: 2
+   :caption: Text Preprocessing Functions:
 
-`pip install -r requirements.txt`
+   modules
 
-then you can install it via pip:
+.. toctree::
+   :maxdepth: 2
+   :caption: Basic preprocessing:
 
-`pip install -e .`
+   nlpretext.basic
 
 
 .. toctree::
    :maxdepth: 2
-   :caption: Preprocessing and utility functions:
+   :caption: Social preprocessing:
 
-   modules
+   nlpretext.social
 
 .. toctree::
    :maxdepth: 2
-   :caption: Preprocessing and utility functions:
-
-   nautilus_nlp.utils
+   :caption: Token preprocessing:
 
+   nlpretext.token
 
 .. toctree::
    :maxdepth: 2
-   :caption: Machine learning:
+   :caption: Text Augmentation:
 
-   nautilus_nlp.models
+   nlpretext.augmentation
 
 Indices and tables
 ==================

diff --git a/docs/modules.rst b/docs/modules.rst
@@ -1,7 +1,7 @@
-nautilus_nlp
-============
+nlpretext
+=========
 
 .. toctree::
    :maxdepth: 4
 
-   nautilus_nlp
+   nlpretext
diff --git a/docs/nautilus_nlp.config.rst b/docs/nautilus_nlp.config.rst
diff --git a/docs/nautilus_nlp.data.rst b/docs/nautilus_nlp.data.rst
diff --git a/docs/nautilus_nlp.features.rst b/docs/nautilus_nlp.features.rst
diff --git a/docs/nautilus_nlp.models.rst b/docs/nautilus_nlp.models.rst
diff --git a/docs/nautilus_nlp.rst b/docs/nautilus_nlp.rst