Merge pull request #56 from dayyass/develop

release v0.1.0

Author: dayyass

.coveragerc

@@ -0,0 +1,17 @@
+[run]
+branch = True
+source = pytorch_ner
+
+[report]
+exclude_lines =
+    pragma: no cover
+    if self\.debug
+    raise AssertionError
+    raise NotImplementedError
+    if __name__ == .__main__.:
+
+omit =
+    pytorch_ner/__main__.py
+
+show_missing = True
+ignore_errors = False

.dockerignore

@@ -0,0 +1,38 @@
+# This workflow will install Python dependencies and run codecov
+# https://github.com/codecov/codecov-action#example-workflowyml-with-codecov-action
+
+name: codecov
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main, develop]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Python
+      uses: actions/setup-python@master
+      with:
+        python-version: 3.7
+    - name: Install dependencies
+      run: |
+        pip install --upgrade pip
+        pip install -r requirements.txt
+        pip install pytest pytest-cov
+    - name: Generate coverage report
+      run: |
+        pytest --cov=./ --cov-report=xml
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v2
+      with:
+        flags: unittests
+        env_vars: OS,PYTHON
+        fail_ci_if_error: true
+        verbose: true

.github/workflows/codecov.yml

@@ -1,26 +1,29 @@
-# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# This workflow will install Python dependencies and run linter
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
-name: lint
+name: linter
 
 on:
   push:
-    branches: [ main ]
+    branches: [main, develop]
   pull_request:
-    branches: [ main ]
+    branches: [main, develop]
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Python 3.8
+    - name: Set up Python
       uses: actions/setup-python@v2
       with:
-        python-version: 3.8
+        python-version: 3.7
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
+        pip install --upgrade pip
         pip install isort black flake8 types-PyYAML mypy
     - name: Code format check with isort
       run: |

.github/workflows/lint.yml renamed to .github/workflows/linter.yml

@@ -1,32 +1,31 @@
-# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# This workflow will install Python dependencies and run tests with a variety of Python versions
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
-name: test
+name: tests
 
 on:
   push:
-    branches: [ main ]
+    branches: [main, develop]
   pull_request:
-    branches: [ main ]
+    branches: [main, develop]
 
 jobs:
   build:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: ['3.6', '3.7', '3.8']
-        os: [ubuntu-latest]  # macOS-latest, windows-latest
+        python-version: ['3.6', '3.7', '3.8', '3.9']
+        os: [ubuntu-latest, macOS-latest, windows-latest]
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Python ${{ matrix.python-version }}
+    - name: Set up Python
       uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
-        python -m pip install pytest
+        pip install --upgrade pip
         pip install -r requirements.txt
-    - name: Test with pytest
+    - name: Tests
       run: |
-        pytest
+        python -m unittest discover

.github/workflows/test.yml renamed to .github/workflows/tests.yml

@@ -1,6 +1,22 @@
 *.DS_Store
-*__pycache__/
-*.pyc
-/venv/
-/models/
+.python-version
+*.ipynb
+*.ipynb_checkpoints
+
+# cache
+*__pycache__
+*.mypy_cache
+*.cache
+
+# coverage
+*.coverage
+*coverage.xml
+
+venv
 .idea
+dist
+
+*.egg-info
+
+models/*
+!models/README.md

.gitignore

@@ -1,30 +1,33 @@
 repos:
-- repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v3.3.0
-  hooks:
-    - id: no-commit-to-branch
-      args: ['--branch', 'main']
+
 - repo: https://github.com/pre-commit/mirrors-isort
   rev: v5.6.4
   hooks:
     - id: isort
       args: ["--profile", "black"]
+
 - repo: https://github.com/psf/black
   rev: 20.8b1
   hooks:
     - id: black
+
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v2.3.0
   hooks:
+    - id: flake8
+      args: ["--ignore", "E501,W503"]
+    - id: check-json
     - id: check-yaml
-    - id: name-tests-test
-      args: ['--django']
+    # - id: name-tests-test
+    #   args: ['--django']
     - id: debug-statements
+    - id: end-of-file-fixer
+      types: [python]
     - id: trailing-whitespace
     - id: check-docstring-first
     - id: requirements-txt-fixer
-    - id: flake8
-      args: ["--ignore", "E501,W503"]
+    - id: check-added-large-files
+
 - repo: https://github.com/pre-commit/mirrors-mypy
   rev: v0.790
   hooks:

.pre-commit-config.yaml

@@ -1,12 +1,12 @@
-FROM pytorch/pytorch:1.6.0-cuda10.1-cudnn7-runtime
+FROM python:3.7-slim-buster
 MAINTAINER Dani El-Ayyass <[email protected]>
 
-COPY requirements.txt .
+WORKDIR /workdir
 
-RUN pip install --upgrade pip
-RUN pip install -r requirements.txt
+COPY config.yaml ./
+COPY data/conll2003/* data/conll2003/
 
-EXPOSE 6006
-VOLUME /workspace
-WORKDIR /workspace
+RUN pip install --upgrade pip && \
+    pip install --no-cache-dir pytorch-ner
 
+CMD ["bash"]