Merge pull request #3 from ddaskan/V0.1.1

V0.1.1

Author: ddaskan

.github/workflows/test_coverage.yml

@@ -5,6 +5,8 @@ name: tests
 
 on:
   workflow_dispatch:
+  schedule:
+    - cron:  '0 */2 * * *'
   push:
     branches: [ master ]
   pull_request:
@@ -17,7 +19,7 @@ jobs:
     strategy:
       matrix:
         os: [macos-latest, ubuntu-latest, windows-latest]
-        python-version: [3.5, 3.6, 3.7, 3.8]
+        python-version: [3.6, 3.7, 3.8, 3.9]
 
     steps:
     - uses: actions/checkout@v2
@@ -34,7 +36,8 @@ jobs:
         pip install pytest
         pip install pytest-cov
         python -m doctest README.md
-        pytest --doctest-modules --junitxml=junit/test-results-${{ matrix.os }}-py${{ matrix.python-version }}.xml --cov=trendypy --cov-report=xml --cov-report=html
+        python -m doctest docs/source/quickstart.rst
+        pytest --doctest-modules --junitxml=junit/test-results-${{ matrix.os }}-py${{ matrix.python-version }}.xml --cov=mlqa --cov-report=xml --cov-report=html
     - name: Upload pytest test results
       uses: actions/upload-artifact@v2
       with:

.github/workflows/upload_pypi.yml

@@ -0,0 +1,31 @@
+# This workflows will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Upload to PyPI
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*

README.md

@@ -1,8 +1,11 @@
-# MLQA <img src="docs/_static/mlqa.png" align="right" width="120"/>
+# MLQA 
+
+<img src="https://raw.githubusercontent.com/ddaskan/mlqa/master/docs/_static/mlqa.png" align="right" width="120"/>
 
 [![PyPI](https://img.shields.io/pypi/v/mlqa)](https://pypi.org/project/mlqa/)
+[![tests](https://github.com/ddaskan/mlqa/workflows/tests/badge.svg)](https://github.com/ddaskan/mlqa/actions?query=workflow%3Atests)
+[![Codecov](https://codecov.io/gh/ddaskan/mlqa/master.svg)](https://codecov.io/gh/ddaskan/mlqa/)
 [![Documentation Status](https://readthedocs.org/projects/mlqa/badge/?version=latest)](https://mlqa.readthedocs.io/en/latest/?badge=latest)
-[![PyPI - License](https://img.shields.io/pypi/l/mlqa)](https://github.com/ddaskan/mlqa/blob/master/LICENSE)
 [![PyPI - Downloads](https://img.shields.io/pypi/dm/mlqa)](https://pypi.org/project/mlqa/)
 [![GitHub last commit](https://img.shields.io/github/last-commit/ddaskan/mlqa)](https://github.com/ddaskan/mlqa)
 [![Twitter](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2Fddaskan%2Fmlqa)](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fddaskan%2Fmlqa)
@@ -19,7 +22,7 @@ You can install MLQA with pip.
 
 `pip install mlqa`
 
-MLQA depends on Pandas and Numpy and works in Python 3.5+.
+MLQA depends on Pandas and Numpy and works in Python 3.6+.
 
 ## Quickstart
 
@@ -48,4 +51,4 @@ See more examples at [Documentation/Quickstart](https://mlqa.readthedocs.io/en/l
 Tests are written with [unittest](https://docs.python.org/3/library/unittest.html) and can be located in the [tests](tests/) folder. There are also some tests in docstring to be run by [doctest](https://docs.python.org/3/library/doctest.html).
 
 ## License
-[MIT](LICENSE)
+[MIT](https://github.com/ddaskan/mlqa/blob/master/LICENSE)

docs/conf.py

@@ -25,7 +25,7 @@
 author = 'Dogan Askan'
 
 # The full version, including alpha/beta/rc tags
-release = '0.1.0.post2'
+release = '0.1.1'
 
 
 # -- General configuration ---------------------------------------------------

mlqa/identifiers.py

@@ -63,7 +63,6 @@ class DiffChecker():
         >>> dc.set_threshold(0.1)
         >>> dc.check(pd.DataFrame({'mean_col':[1, 1.5]*50, 'na_col':[None]*70+[1]*30}))
         False
-        >>> os.remove('mylog.log')
 
     '''
     stats = []
@@ -183,10 +182,10 @@ def set_threshold(self, threshold):
                   col1  col2
             mean   0.2   0.1
             max    0.2   0.1
-            >>> dc.set_threshold({'col1':{'mean':0.1}}) # to set in column-stat level
+            >>> dc.set_threshold({'col1':{'mean':0.3}}) # to set in column-stat level
             >>> print(dc.threshold_df)
                   col1  col2
-            mean   0.1   0.1
+            mean   0.3   0.1
             max    0.2   0.1
 
         '''
@@ -254,7 +253,7 @@ def fit(self, df):
                     self.df_fit_stats.loc[stat_name, col] = df[col].agg(stat)
 
         self.threshold_df = self.df_fit_stats.copy()
-        self.threshold_df.replace(self.threshold_df, np.NaN, inplace=True)
+        self.threshold_df.loc[:, :] = np.NaN
 
     def check(self, df_to_check, columns=None, columns_to_exclude=None):
         '''Checks given `df_to_check` based on fitted `df` stats.

requirements.txt

@@ -1,2 +1,2 @@
-numpy
-pandas
+numpy>=1.19.4
+pandas>=1.1.5

setup.py

@@ -8,7 +8,7 @@
 
 setuptools.setup(
     name="mlqa",
-    version="0.1.0.post2",
+    version="0.1.1",
     author="Dogan Askan",
     author_email="[email protected]",
     description="A Package to perform QA on data flows for Machine Learning.",
@@ -32,6 +32,6 @@
         "Topic :: Scientific/Engineering :: Artificial Intelligence",
         "Topic :: Software Development",
     ],
-    python_requires='>=3.5',
+    python_requires='>=3.6',
     install_requires=install_requires,
 )

tests/test_identifier.py

@@ -239,7 +239,7 @@ def test_check(self):
             dcr.check(self.df1)
         self.assertRegex(
             log.output[0],
-            "^WARNING:test_mlqa:mean value \(i.e. 0.73\) is not in the (.*) "
+            "^WARNING:test_mlqa:mean value \\(i.e. 0.73\\) is not in the (.*) "
             "for Siblings/Spouses Aboard$")
         self.assertEqual(
             log.output[1],