make release-tag: Merge branch 'master' into stable

Author: csala

.github/workflows/tests.yml

@@ -7,34 +7,87 @@ on:
     branches: [ master ]
 
 jobs:
-  build:
+  lint:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: [3.5, 3.6, 3.7]
-        os: [ubuntu-latest]
+        python-version: [3.8]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - if: matrix.os == 'windows-latest'
+      name: Install dependencies - Windows
+      run: pip install 'torch>=1,<2' -f https://download.pytorch.org/whl/torch_stable.html
+    - name: Install package
+      run: pip install invoke .[dev]
+    - name: invoke lint
+      run: invoke lint
 
+  readme:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8]
+        os: [ubuntu-latest, macos-latest]
     steps:
     - uses: actions/checkout@v1
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v1
       with:
         python-version: ${{ matrix.python-version }}
+    - name: Install package and dependencies
+      run: pip install invoke rundoc .
+    - name: invoke readme
+      run: invoke readme
 
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install tox tox-gh-actions
+  unit:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - if: matrix.os == 'windows-latest'
+      name: Install dependencies - Windows
+      run: pip install 'torch>=1,<2' -f https://download.pytorch.org/whl/torch_stable.html
+    - name: Install package and dependencies
+      run: pip install invoke .[test]
+    - name: invoke pytest
+      run: invoke pytest
 
+  tutorials:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8]
+        os: [ubuntu-latest]
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
     - if: matrix.os == 'ubuntu-latest'
-      name: Install pandoc - Ubuntu
-      run: |
-        sudo apt install pandoc
-
+      name: Install dependencies - Ubuntu
+      run: sudo apt-get install graphviz
     - if: matrix.os == 'macos-latest'
-      name: Install pandoc - MacOS
+      name: Install dependencies - MacOS
+      run: brew install graphviz
+    - if: matrix.os == 'windows-latest'
+      name: Install dependencies - Windows
       run: |
-        brew install pandoc
-
-    - name: Test with tox
-      run: tox
+        pip install 'torch>=1,<2' -f https://download.pytorch.org/whl/torch_stable.html
+        choco install graphviz
+    - name: Install package and dependencies
+      run: pip install invoke jupyter .[ctgan]
+    - name: invoke tutorials
+      run: invoke tutorials

.travis.yml

@@ -1,20 +1,22 @@
 # Config file for automatic testing at travis-ci.org
+os: linux
 dist: bionic
 language: python
 python:
-  - 3.8
-  - 3.7
   - 3.6
-  - 3.5
+  - 3.7
+  - 3.8
+env:
+  - TOXENV=lint
+  - TOXENV=readme
+  - TOXENV=pytest
+  - TOXENV=tutorials
 
 # Command to install dependencies
-addons:
-  apt:
-    packages:
-      - pandoc
-install: pip install -U tox-travis codecov
+install:
+  - sudo apt-get update
+  - pip install -U tox-travis codecov
 
 after_success: codecov
 
-# Command to run tests
-script: tox
+script: travis_wait 60 tox

HISTORY.md

@@ -1,5 +1,35 @@
 # History
 
+## v0.1.0 - 2020-12-18
+
+This release introduces a new project organization and API, with metrics
+grouped by data modality, with a common API:
+
+* Single Column
+* Column Pair
+* Single Table
+* Multi Table
+* Time Series
+
+Within each data modality, different families of metrics have been implemented:
+
+* Statistical
+* Detection
+* Bayesian Network and Gaussian Mixture Likelihood
+* Machine Learning Efficacy
+
+## v0.0.4 - 2020-11-27
+
+Patch release to relax dependencies and avoid conflicts when using the latest SDV version.
+
+## v0.0.3 - 2020-11-20
+
+Fix error on detection metrics when input data contains infinity or NaN values.
+
+### Issues closed
+
+* ValueError: Input contains infinity or a value too large for dtype('float64') - Issue [#11](https://github.com/sdv-dev/SDMetrics/issues/11) by @csala
+
 ## v0.0.2 - 2020-08-08
 
 Add support for Python 3.8 and a broader range of dependencies.

INSTALL.md

@@ -0,0 +1,60 @@
+# Installing SDMetrics
+
+## Requirements
+
+**SDMetrics** has been developed and tested on [Python 3.6, 3.7 and 3.8](https://www.python.org/downloads/)
+
+Also, although it is not strictly required, the usage of a [virtualenv](
+https://virtualenv.pypa.io/en/latest/) is highly recommended in order to avoid
+interfering with other software installed in the system where **SDMetrics** is run.
+
+## Install with pip
+
+The easiest and recommended way to install **SDMetrics** is using [pip](
+https://pip.pypa.io/en/stable/):
+
+```bash
+pip install sdmetrics
+```
+
+This will pull and install the latest stable release from [PyPi](https://pypi.org/).
+
+## Install with conda
+
+**SDMetrics** can also be installed using [conda](https://docs.conda.io/en/latest/):
+
+```bash
+conda install -c sdv-dev -c conda-forge sdmetrics
+```
+
+This will pull and install the latest stable release from [Anaconda](https://anaconda.org/).
+
+## Install from source
+
+If you want to install **SDMetrics** from source you need to first clone the repository
+and then execute the `make install` command inside the `stable` branch. Note that this
+command works only on Unix based systems like GNU/Linux and macOS:
+
+```bash
+git clone https://github.com/sdv-dev/SDMetrics
+cd SDMetrics
+git checkout stable
+make install
+```
+
+## Install for development
+
+If you intend to modify the source code or contribute to the project you will need to
+install it from the source using the `make install-develop` command. In this case, we
+recommend you to branch from `master` first:
+
+```bash
+git clone git@github.com:sdv-dev/SDMetrics
+cd SDMetrics
+git checkout master
+git checkout -b <your-branch-name>
+make install-develp
+```
+
+For more details about how to contribute to the project please visit the [Contributing Guide](
+CONTRIBUTING.rst).

MANIFEST.in

@@ -3,6 +3,7 @@ include CONTRIBUTING.rst
 include HISTORY.md
 include LICENSE
 include README.md
+include sdmetrics/demos/*.pkl
 
 recursive-include tests *
 recursive-exclude * __pycache__

Makefile

@@ -87,8 +87,7 @@ install-develop: clean-build clean-pyc ## install the package in editable mode a
 
 .PHONY: lint
 lint: ## check style with flake8 and isort
-	flake8 sdmetrics tests
-	isort -c --recursive sdmetrics tests
+	invoke lint
 
 .PHONY: fix-lint
 fix-lint: ## fix lint issues using autoflake, autopep8, and isort
@@ -101,17 +100,15 @@ fix-lint: ## fix lint issues using autoflake, autopep8, and isort
 
 .PHONY: test-unit
 test-unit: ## run tests quickly with the default Python
-	python -m pytest --cov=sdmetrics
+	invoke pytest
 
 .PHONY: test-readme
 test-readme: ## run the readme snippets
-	rm -rf tests/readme_test && mkdir tests/readme_test
-	cd tests/readme_test && rundoc run --single-session python3 -t python3 ../../README.md
-	rm -rf tests/readme_test
+	invoke readme
 
 .PHONY: test-tutorials
 test-tutorials: ## run the tutorial notebooks
-	jupyter nbconvert --execute --ExecutePreprocessor.timeout=600 tutorials/*.ipynb --stdout > /dev/null
+	invoke tutorials
 
 .PHONY: test
 test: test-unit test-readme test-tutorials ## test everything that needs test dependencies