Merge pull request #42 from fidelity/batch_processing

Batch processing

Author: takojunior

.github/workflows/ci.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: ['3.6', '3.7', '3.8', '3.9', '3.10']
+        python-version: ['3.7', '3.8', '3.9', '3.10']
         os: [ubuntu-latest, macos-latest, windows-latest]
     steps:
       - uses: actions/checkout@v3

CHANGELOG.txt

@@ -2,6 +2,16 @@
 CHANGELOG
 =========
 
+-------------------------------------------------------------------------------
+Apr, 12, 2023 1.4.0
+-------------------------------------------------------------------------------
+
+Major:
+- Enable running Seq2Pat on batches of sequences in parallel
+- Add a usage example notebook to show how batch processing is called
+- Enrich documentations and comments relevant to batch processing and a few tests
+- Explicitly require that input integer sequences only contain positive integers
+
 -------------------------------------------------------------------------------
 July, 13, 2022 1.3.4
 -------------------------------------------------------------------------------

README.md

@@ -22,6 +22,10 @@ Seq2Pat is developed as a joint collaboration between Fidelity Investments
 and the Tepper School of Business at CMU. Documentation is available at [fidelity.github.io/seq2pat](https://fidelity.github.io/seq2pat).
 
 ## Quick Start
+
+We present examples for constraint-based sequential pattern mining and dichotomic pattern mining. 
+Sequences can be represented as strings or positive integers.
+
 ### Constraint-based Sequential Pattern Mining
 ```python
 # Example to show how to find frequent sequential patterns
@@ -95,7 +99,8 @@ The library offers various constraint types, including a number of non-monotone
 ## Usage Examples
 
 Examples on how to use the available constraints can be found 
-in the [Usage Example Notebook](https://github.com/fidelity/seq2pat/blob/master/notebooks/usage_example.ipynb).
+in the [Usage Example Notebook](https://github.com/fidelity/seq2pat/blob/master/notebooks/sequential_pattern_mining.ipynb).
+You can also find out how to scale up the mining capability, by running Seq2Pat on batches of sequences in parallel in [Batch Processing Notebook](https://github.com/fidelity/seq2pat/blob/master/notebooks/batch_processing.ipynb). 
 
 Supported by Seq2Pat, we proposed **Dichotomic Pattern Mining** ([X. Wang and S. Kadioglu, 2022](https://arxiv.org/abs/2201.09178)) to analyze the correlations between 
 mined patterns and different outcomes of sequences. DPM allows generating feature vectors based on mined patterns and plays an integrator role between Sequential 
@@ -109,7 +114,7 @@ our [documentation](https://fidelity.github.io/seq2pat/installation.html).
 
 ### Requirements
 
-The library requires ```Python 3.6+```, the ```Cython``` package, and a ```C++``` compiler.
+The library requires ```Python 3.7+```, the ```Cython``` package, and a ```C++``` compiler.
 See [requirements.txt](requirements.txt) for dependencies.
 
 ## Support
@@ -124,11 +129,11 @@ If you use Seq2Pat in a publication, please cite it as:
   @article{seq2pat2022,
     title={Seq2Pat: Sequence-to-Pattern Generation for Constraint-based Sequential Pattern Mining},
     author={Wang Xin, Hosseininasab Amin, Colunga Pablo, Kadioglu Serdar, van Hoeve Willem-Jan},
-    url={https://github.com/fidelity/textwiser},
     journal={Proceedings of the AAAI Conference on Artificial Intelligence},
-    volume={TBD},
-    number={TBD},
-    pages={TBD},
+    url={https://ojs.aaai.org/index.php/AAAI/article/view/21542},
+    volume={36},
+    number={11},
+    pages={12665-12671},
     year={2022}
   }
 ```
@@ -139,10 +144,9 @@ To cite the Dichotomic Pattern Mining framework, please cite it as:
   @article{Frontiers2022,
     title={Dichotomic Pattern Mining Integrated with Constraint Reasoning for Digital Behaviour Analyses}, 
     author={Sohom Ghosh, Shefali Yadav, Xin Wang, Bibhash Chakrabarty, Serdar Kadioglu},
-    journal={Frontiers Journal on Knowledge Discovery from Unstructured Data in Finance},
-    volume={TBD},
-    number={TBD},
-    pages={TBD},
+    journal={Frontiers in Artificial Intelligence},
+    url={https://www.frontiersin.org/articles/10.3389/frai.2022.868085},
+    volume={5},
     year={2022}    
 }
 ```
@@ -152,9 +156,9 @@ To cite the Dichotomic Pattern Mining framework, please cite it as:
     title={Dichotomic Pattern Mining with Applications to Intent Prediction from Semi-Structured Clickstream Datasets}, 
     author={Xin Wang and Serdar Kadioglu},
     booktitle={The AAAI-22 Workshop on Knowledge Discovery from Unstructured Data in Financial Services},
-    year={2022},
-    eprint={2201.09178},
-    archivePrefix={arXiv}
+    publisher={arXiv},
+    url={https://arxiv.org/abs/2201.09178},
+    year={2022}
 }
 ```
 

docs/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: dc64ee1df7963973e104a0b15e897a4e
+config: f4e53c38a24fe1d8ea17a0366eda0aae
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_modules/index.html

@@ -13,6 +13,7 @@
         <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
         <script src="../_static/jquery.js"></script>
         <script src="../_static/underscore.js"></script>
+        <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
         <script src="../_static/doctools.js"></script>
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />