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

sdv-dev · Feb 1, 2023 · 5e2dbdf · 5e2dbdf
2 parents c531288 + 9ecedb7
commit 5e2dbdf
Show file tree

Hide file tree

Showing 49 changed files with 1,920 additions and 960 deletions.
diff --git a/.github/workflows/integration.yml b/.github/workflows/integration.yml
@@ -9,20 +9,24 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
-        os: [ubuntu-latest, macos-10.15, windows-latest]
+        python-version: ['3.7', '3.8', '3.9', '3.10']
+        os: [ubuntu-latest, macos-latest, windows-latest]
     steps:
     - uses: actions/checkout@v1
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python-version }}
-    - if: matrix.os == 'windows-latest'
+    - if: matrix.os == 'windows-latest' && matrix.python-version != '3.10'
       name: Install dependencies - Windows
       run: |
           python -m pip install --upgrade pip
           python -m pip install 'torch==1.8.0' -f https://download.pytorch.org/whl/cpu/torch/
-          python -m pip install 'torchvision==0.9.0' -f https://download.pytorch.org/whl/cpu/torchvision/
+    - if: matrix.os == 'windows-latest' && matrix.python-version == '3.10'
+      name: Install dependencies - Windows
+      run: |
+          python -m pip install --upgrade pip
+          python -m pip install 'torch==1.11.0' -f https://download.pytorch.org/whl/cpu/torch/
     - name: Install dependencies
       run: |
           python -m pip install --upgrade pip

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -10,7 +10,7 @@ jobs:
     steps:
     - uses: actions/checkout@v1
     - name: Set up Python 3.8
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v2
       with:
         python-version: 3.8
     - name: Install dependencies

diff --git a/.github/workflows/minimum.yml b/.github/workflows/minimum.yml
@@ -9,20 +9,24 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
-        os: [ubuntu-latest, macos-10.15, windows-latest]
+        python-version: ['3.7', '3.8', '3.9', '3.10']
+        os: [ubuntu-latest, macos-latest, windows-latest]
     steps:
     - uses: actions/checkout@v1
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python-version }}
-    - if: matrix.os == 'windows-latest'
+    - if: matrix.os == 'windows-latest' && matrix.python-version != 3.10
       name: Install dependencies - Windows
       run: |
           python -m pip install --upgrade pip
           python -m pip install 'torch==1.8.0' -f https://download.pytorch.org/whl/cpu/torch/
-          python -m pip install 'torchvision==0.9.0' -f https://download.pytorch.org/whl/cpu/torchvision/
+    - if: matrix.os == 'windows-latest' && matrix.python-version == 3.10
+      name: Install dependencies - Windows
+      run: |
+          python -m pip install --upgrade pip
+          python -m pip install 'torch==1.11.0' -f https://download.pytorch.org/whl/cpu/torch/
     - name: Install dependencies
       run: |
           python -m pip install --upgrade pip

diff --git a/.github/workflows/readme.yml b/.github/workflows/readme.yml
@@ -9,12 +9,12 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
-        os: [ubuntu-latest, macos-10.15]   # skip windows bc rundoc fails
+        python-version: ['3.7', '3.8', '3.9', '3.10']
+        os: [ubuntu-latest, macos-latest]   # skip windows bc rundoc fails
     steps:
     - uses: actions/checkout@v1
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies

diff --git a/.github/workflows/unit.yml b/.github/workflows/unit.yml
@@ -9,20 +9,24 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
-        os: [ubuntu-latest, macos-10.15, windows-latest]
+        python-version: ['3.7', '3.8', '3.9', '3.10']
+        os: [ubuntu-latest, macos-latest, windows-latest]
     steps:
     - uses: actions/checkout@v1
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python-version }}
-    - if: matrix.os == 'windows-latest'
+    - if: matrix.os == 'windows-latest' && matrix.python-version != 3.10
       name: Install dependencies - Windows
       run: |
           python -m pip install --upgrade pip
           python -m pip install 'torch==1.8.0' -f https://download.pytorch.org/whl/cpu/torch/
-          python -m pip install 'torchvision==0.9.0' -f https://download.pytorch.org/whl/cpu/torchvision/
+    - if: matrix.os == 'windows-latest' && matrix.python-version == 3.10
+      name: Install dependencies - Windows
+      run: |
+          python -m pip install --upgrade pip
+          python -m pip install 'torch==1.11.0' -f https://download.pytorch.org/whl/cpu/torch/
     - name: Install dependencies
       run: |
           python -m pip install --upgrade pip

diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -1,10 +1 @@
-Credits
-=======
-
-Contributors
-------------
-
-* Lei Xu <[email protected]>
-* Kalyan Veeramachaneni <[email protected]>
-* Manuel Alvarez <[email protected]>
-* Carles Sala <[email protected]>
+See: https://github.com/sdv-dev/SDGym/graphs/contributors
diff --git a/BENCHMARK.md b/BENCHMARK.md
@@ -87,13 +87,13 @@ The most basic scenario is to pass a synthesizer function, but the sdgym.run fun
 can also be used to evaluate any `Synthesizer` class, as far as it is a subclass of
 `sdgym.synthesizers.BaseSynthesizer`.
 
-For example, if we want to evaluate the `Independent` we can do so by passing the class
+For example, if we want to evaluate the `IndependentSynthesizer` we can do so by passing the class
 directly to the sdgym.run function:
 
 ```python3
-In [5]: from sdgym.synthesizers import Independent
+In [5]: from sdgym.synthesizers import IndependentSynthesizer
 
-In [6]: scores = sdgym.run(synthesizers=Independent)
+In [6]: scores = sdgym.run(synthesizers=IndependentSynthesizer)
 ```
 
 #### Evaluating multiple Synthesizers
@@ -103,7 +103,7 @@ The `sdgym.run` function can be used to evaluate more than one Synthesizer at a
 In order to do this, all you need to do is pass a list of functions instead of a single
 object.
 
-For example, if we want to evaluate our synthesizer function and also the `Independent`
+For example, if we want to evaluate our synthesizer function and also the `IndependentSynthesizer`
 we can pass both of them inside a list:
 
 ```python3
@@ -113,12 +113,12 @@ In [8]: scores = sdgym.run(synthesizers=synthesizers)
 ```
 
 Or, if we wanted to evaluate all the SDGym Synthesizers at once (note that this takes a lot of time
-to run!), we could just pass all the subclasses of `Baseline`:
+to run!), we could just pass all the subclasses of `BaselineSynthesizer`:
 
 ```python3
-In [9]: from sdgym.synthesizers import Baseline
+In [9]: from sdgym.synthesizers import BaselineSynthesizer
 
-In [10]: scores = sdgym.run(Baseline.get_subclasses())
+In [10]: scores = sdgym.run(BaselineSynthesizer.get_subclasses())
 ```
 
 #### Customizing the Synthesizer names.
@@ -132,7 +132,7 @@ putting the names as keys and the functions or classes as the values:
 ```python3
 In [11]: synthesizers = {
     ...:     'My Synthesizer': my_synthesizer_function,
-    ...:     'SDGym Independent': Independent
+    ...:     'SDGym Independent': IndependentSynthesizer
     ...: }
 
 In [12]: scores = sdgym.run(synthesizers=synthesizers)

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -120,8 +120,8 @@ Before you submit a pull request, check that it meets these guidelines:
 4. If the pull request adds functionality, the docs should be updated. Put
    your new functionality into a function with a docstring, and add the
    feature to the list in README.rst.
-5. The pull request should work for Python 3.5 and 3.6. Check
-   https://travis-ci.org/sdv-dev/SDGym/pull_requests
+5. The pull request should work for Python 3.7, 3.8, 3.9, and 3.10. Check
+   https://github.com/sdv-dev/SDGym/actions
    and make sure that all the checks pass.
 
 Unit Testing Guidelines

diff --git a/Dockerfile b/Dockerfile
@@ -1,8 +1,8 @@
 FROM nvidia/cuda:11.0.3-cudnn8-devel-ubuntu18.04
 CMD nvidia-smi
 
-RUN apt-get update && apt-get install -y build-essential && apt-get -y install curl
-RUN apt-get -y install python3.8 python3-distutils && ln -s /usr/bin/python3.8 /usr/bin/python
+RUN apt-get update && apt-get install -y build-essential curl python3.7 python3.7-dev \
+    python3-distutils && ln -s /usr/bin/python3.7 /usr/bin/python
 RUN curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py && \
     python get-pip.py && ln -s /usr/bin/pip3 /usr/bin/pip
 
@@ -18,8 +18,8 @@ COPY /privbayes/ /SDGym/privbayes
 WORKDIR /SDGym
 
 # Install project
-RUN make install-all compile
-RUN pip install -U numpy==1.20
+RUN pip install . --no-binary pomegranate
+RUN make compile
 ENV PRIVBAYES_BIN /SDGym/privbayes/privBayes.bin
 ENV TF_CPP_MIN_LOG_LEVEL 2
 

diff --git a/HISTORY.md b/HISTORY.md
@@ -1,5 +1,50 @@
 # History
 
+## v0.6.0 - 2021-02-01
+This release introduces methods for benchmarking single table data and creating custom synthesizers, which can be based on existing SDGym-defined synthesizers or on user-defined functions. This release also adds support for Python 3.10 and drops support for Python 3.6.
+
+### New Features
+* Benchmarking progress bar should update on one line - Issue [#204](https://github.com/sdv-dev/SDGym/issues/204) by @katxiao
+* Support local additional datasets folder with zip files - Issue [#186](https://github.com/sdv-dev/SDGym/issues/186) by @katxiao
+* Enforce that each synthesizer is unique in benchmark_single_table - Issue [#190](https://github.com/sdv-dev/SDGym/issues/190) by @katxiao
+* Simplify the file names inside the detailed_results_folder - Issue [#191](https://github.com/sdv-dev/SDGym/issues/191) by @katxiao
+* Use SDMetrics silent report generation - Issue [#179](https://github.com/sdv-dev/SDGym/issues/179) by @katxiao
+* Remove arguments in get_available_datasets - Issue [#197](https://github.com/sdv-dev/SDGym/issues/197) by @katxiao
+* Accept metadata.json as valid metadata file - Issue [#194](https://github.com/sdv-dev/SDGym/issues/194) by @katxiao
+* Check if file or folder exists before writing benchmarking results - Issue [#196](https://github.com/sdv-dev/SDGym/issues/196) by @katxiao
+* Rename benchmarking argument "evaluate_quality" to "compute_quality_score" - Issue [#195](https://github.com/sdv-dev/SDGym/issues/195) by @katxiao
+* Add option to disable sdmetrics in benchmarking - Issue [#182](https://github.com/sdv-dev/SDGym/issues/182) by @katxiao
+* Prefix remote bucket with 's3' - Issue [#183](https://github.com/sdv-dev/SDGym/issues/183) by @katxiao
+* Benchmarking error handling - Issue [#177](https://github.com/sdv-dev/SDGym/issues/177) by @katxiao
+* Allow users to specify custom synthesizers' display names - Issue [#174](https://github.com/sdv-dev/SDGym/issues/174) by @katxiao
+* Update benchmarking results columns - Issue [#172](https://github.com/sdv-dev/SDGym/issues/172) by @katxiao
+* Allow custom datasets - Issue [#166](https://github.com/sdv-dev/SDGym/issues/166) by @katxiao
+* Use new datasets s3 bucket - Issue [#161](https://github.com/sdv-dev/SDGym/issues/161) by @katxiao
+* Create benchmark_single_table method - Issue [#151](https://github.com/sdv-dev/SDGym/issues/151) by @katxiao
+* Update summary metrics - Issue [#134](https://github.com/sdv-dev/SDGym/issues/134) by @katxiao
+* Benchmark individual methods - Issue [#159](https://github.com/sdv-dev/SDGym/issues/159) by @katxiao
+* Add method to create a sdv variant synthesizer - Issue [#152](https://github.com/sdv-dev/SDGym/issues/152) by @katxiao
+* Add method to generate a multi table synthesizer - Issue [#149](https://github.com/sdv-dev/SDGym/issues/149) by @katxiao
+* Add method to create single table synthesizers - Issue [#148](https://github.com/sdv-dev/SDGym/issues/148) by @katxiao
+* Updating existing synthesizers to new API - Issue [#154](https://github.com/sdv-dev/SDGym/issues/154) by @katxiao
+
+### Bug Fixes
+* Pip encounters dependency issues with ipython - Issue [#187](https://github.com/sdv-dev/SDGym/issues/187) by @katxiao
+* IndependentSynthesizer is printing out ConvergeWarning too many times - Issue [#192](https://github.com/sdv-dev/SDGym/issues/192) by @katxiao
+* Size values in benchmarking results seems inaccurate - Issue [#184](https://github.com/sdv-dev/SDGym/issues/184) by @katxiao
+* Import error in the example for benchmarking the synthesizers - Issue [#139](https://github.com/sdv-dev/SDGym/issues/139) by @katxiao
+* Updates and bugfixes - Issue [#132](https://github.com/sdv-dev/SDGym/issues/132) by @csala
+
+### Maintenance
+* Update README - Issue [#203](https://github.com/sdv-dev/SDGym/issues/203) by @katxiao
+* Support Python Versions >=3.7 and <3.11 - Issue [#170](https://github.com/sdv-dev/SDGym/issues/170) by @katxiao
+* SDGym Package Maintenance Updates documentation  - Issue [#163](https://github.com/sdv-dev/SDGym/issues/163) by @katxiao
+* Remove YData - Issue [#168](https://github.com/sdv-dev/SDGym/issues/168) by @katxiao
+* Update to newest SDV - Issue [#157](https://github.com/sdv-dev/SDGym/issues/157) by @katxiao
+* Update slack invite link. - Issue [#144](https://github.com/sdv-dev/SDGym/issues/144) by @pvk-developer
+* updating workflows to work with windows - Issue [#136](https://github.com/sdv-dev/SDGym/issues/136) by @amontanez24
+* Update conda dependencies - Issue [#130](https://github.com/sdv-dev/SDGym/issues/130) by @katxiao
+
 ## v0.5.0 - 2021-12-13
 This release adds support for Python 3.9, and updates dependencies to accept the latest versions when possible.
 

diff --git a/INSTALL.md b/INSTALL.md
@@ -2,7 +2,7 @@
 
 ## Requirements
 
-**SDGym** has been developed and tested on [Python 3.6, 3.7, 3.8 and 3.9](https://www.python.org/downloads/)
+**SDGym** has been developed and tested on [Python 3.7, 3.8, 3.9, and 3.10](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