Deep feature synthesis task (#20) (#21)

Add DeepFeatureSynthesisTask Add EmailNotifier All tasks can retrieve also data as dataframes (instead only as URL/file path) Add examples with DeepFeatureSynthesisTask Upgrade dependencies
medoidai · Dec 31, 2020 · 22ac014 · 22ac014
1 parent 43efef8
commit 22ac014
Show file tree

Hide file tree

Showing 285 changed files with 19,754 additions and 16,738 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 [![Python](https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8-blue?style=plastic)](https://www.python.org/)
-[![PyPI](https://img.shields.io/badge/pypi_package-1.0.8-blue?style=plastic)](https://pypi.org/project/skrobot/1.0.8/)
+[![PyPI](https://img.shields.io/badge/pypi_package-1.0.9-blue?style=plastic)](https://pypi.org/project/skrobot/1.0.9/)
 [![License](https://img.shields.io/badge/license-MIT-blue?style=plastic)](https://github.com/medoidai/skrobot/blob/master/LICENSE.txt)
-[![Documentation Status](https://readthedocs.org/projects/skrobot/badge/?version=1.0.8)](https://skrobot.readthedocs.io/en/1.0.8/)
+[![Documentation Status](https://readthedocs.org/projects/skrobot/badge/?version=1.0.9)](https://skrobot.readthedocs.io/en/1.0.9/)
 
 -----------------
 
@@ -11,49 +11,29 @@
 
 # skrobot
 
-### What is it about?
+## What is it about?
 
 skrobot is a Python module for designing, running and tracking Machine Learning experiments / tasks. It is built on top of [scikit-learn](https://scikit-learn.org/) framework.
 
-### Documentation?
+## Documentation?
 
-The documentation is hosted online to [Read the Docs](https://skrobot.readthedocs.io/en/1.0.8/).
+The documentation is hosted online to [Read the Docs](https://skrobot.readthedocs.io/en/1.0.9/).
 
-### How do I install it?
-
-#### PyPI
-
-```sh
-$ pip install skrobot
-```
-
-#### Development Version
-
-The skrobot version on PyPI may always be one step behind; you can install the latest development version from the GitHub repository by executing
+## How do I install it?
 
 ```sh
-$ pip install git+git://github.com/medoidai/skrobot.git
+pip install skrobot
 ```
 
-Or, you can clone the GitHub repository and install skrobot from your local drive via
-
-```sh
-$ python setup.py install
-```
-
-### Next Priorities?
+## Next Priorities?
 
 * Add support in the module for multiclass problems
 
-* Build some notifiers (e.g., Slack, Trello and Discord)
-
-* Add a new task for automatic feature synthesis
-
-### Can I contribute?
+## Can I contribute?
 
 Of course, the project is [Free Software](https://www.gnu.org/philosophy/free-sw.en.html) and you can contribute to it!
 
-### What license do you use?
+## What license do you use?
 
 See our license ([LICENSE.txt](https://github.com/medoidai/skrobot/blob/master/LICENSE.txt)) for more details.
 

diff --git a/RELEASE.md b/RELEASE.md
@@ -1,3 +1,11 @@
+# 1.0.9
+
+* Add DeepFeatureSynthesisTask
+* Add EmailNotifier
+* All tasks can retrieve also data as dataframes (instead only as URL/file path)
+* Add examples with DeepFeatureSynthesisTask
+* Upgrade dependencies
+
 # 1.0.8
 
 * Fixed versions in PyPI, Read the Docs.

diff --git a/docs/README.md b/docs/README.md
@@ -11,30 +11,30 @@ Make sure you have [Python](https://www.python.org/), [Git](https://git-scm.com/
 ### Clone the project's repository
 
 ```sh
-$ git clone https://github.com/medoidai/skrobot.git
+git clone https://github.com/medoidai/skrobot.git
 ```
 
 ### Create virtual environment and install dependencies
 
 ```sh
-$ virtualenv -p python docs/venv
-$ source docs/venv/bin/activate
-$ pip install -r docs/requirements.txt
+virtualenv -p python docs/venv
+source docs/venv/bin/activate
+pip install -r docs/requirements.txt
 ```
 
 ### Install skrobot
 
 ```sh
-$ python setup.py install
+python setup.py install
 ```
 
 ## Generate Sphinx documentation
 
 ### HTML documentation
 
 ```sh
-$ cd docs
-$ make html
+cd docs
+make html
 ```
 
 **Thank you!**
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,2 @@
-sphinx==3.3.1
+sphinx==3.4.1
 sphinx-rtd-theme==0.5.0
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -21,7 +21,7 @@
 author = 'Medoid AI'
 
 # The full version, including alpha/beta/rc tags
-release = '1.0.8'
+release = '1.0.9'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/source/how_do_i_install_it.rst b/docs/source/how_do_i_install_it.rst
@@ -1,6 +1,55 @@
 How do I install it?
 ====================
 
+PyPI
+----
+
+.. code:: sh
+
+   pip install skrobot
+
+Graphviz
+--------
+
+If you want to export feature computation graphs using the argument ``export_feature_graphs`` in :class:`.DeepFeatureSynthesisTask` class, you need to install Graphviz.
+
+Conda users:
+
+.. code:: sh
+
+    conda install python-graphviz
+
+GNU/Linux:
+
+.. code:: sh
+
+    sudo apt-get install graphviz
+    pip install graphviz
+
+Mac OS:
+
+.. code:: sh
+
+    brew install graphviz
+    pip install graphviz
+
+Windows:
+
+.. code:: sh
+
+    conda install python-graphviz
+
+Development Version
+-------------------
+
+The skrobot version on PyPI may always be one step behind; you can install the latest development version from the GitHub repository by executing
+
+.. code:: sh
+
+    pip install git+git://github.com/medoidai/skrobot.git
+
+Or, you can clone the GitHub repository and install skrobot from your local drive via
+
 .. code:: sh
 
-   $ pip install skrobot
+    python setup.py install