Merge pull request #457 from rasbt/image-module

Setup a mlxtend.image placeholder module

docs/mkdocs.yml

@@ -94,6 +94,8 @@ pages:
     - user_guide/general_concepts/gradient-optimization.md
     - user_guide/general_concepts/linear-gradient-derivative.md
     - user_guide/general_concepts/regularization-linear.md
+  - image:
+    - user_guide/image/extract_face_landmarks.md
   - math:
     - user_guide/math/num_combinations.md
     - user_guide/math/num_permutations.md

docs/sources/USER_GUIDE_INDEX.md

@@ -66,6 +66,9 @@
 - [linear-gradient-derivative](user_guide/general_concepts/linear-gradient-derivative.md)
 - [regularization-linear](user_guide/general_concepts/regularization-linear.md)
 
+## `image`
+- [extract_face_landmarks](user_guide/image/extract_face_landmarks.md)
+
 ## `math`
 - [num_combinations](user_guide/math/num_combinations.md)
 - [num_permutations](user_guide/math/num_permutations.md)

docs/sources/user_guide/image/extract_face_images.ipynb

@@ -0,0 +1,113 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Counter"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "A function extract facial landmarks."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "> from mlxtend.image import extract_face_landmarks"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Overview"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "The `extract_face_landmarks` function ..."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### References\n",
+    "\n",
+    "- -"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Example 1 - Text"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Note that the first number displays the current iteration, and the second number shows the time elapsed after initializing the `Counter`."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## API"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "with open('../../api_modules/mlxtend.image/extract_face_landmarks.md', 'r') as f:\n",
+    "    print(f.read())"
+   ]
+  }
+ ],
+ "metadata": {
+  "anaconda-cloud": {},
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.6.6"
+  },
+  "toc": {
+   "nav_menu": {},
+   "number_sections": false,
+   "sideBar": true,
+   "skip_h1_title": false,
+   "title_cell": "Table of Contents",
+   "title_sidebar": "Contents",
+   "toc_cell": false,
+   "toc_position": {},
+   "toc_section_display": true,
+   "toc_window_display": false
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 1
+}

mlxtend/image/__init__.py

@@ -0,0 +1,9 @@
+# Sebastian Raschka 2014-2018
+# mlxtend Machine Learning Library Extensions
+# Author: Sebastian Raschka <sebastianraschka.com>
+#
+# License: BSD 3 clause
+
+from .extract_face_landmarks import extract_face_landmarks
+
+__all__ = ["extract_face_landmarks"]

mlxtend/image/extract_face_landmarks.py

@@ -0,0 +1,11 @@
+# Sebastian Raschka 2014-2018
+# mlxtend Machine Learning Library Extensions
+#
+# A counter class for printing the progress of an iterator.
+# Author: Sebastian Raschka <sebastianraschka.com>
+#
+# License: BSD 3 clause
+
+
+def extract_face_landmarks():
+    pass

mlxtend/image/tests/test_extract_face_landmarks.py

@@ -0,0 +1,11 @@
+# Sebastian Raschka 2014-2018
+# mlxtend Machine Learning Library Extensions
+# Author: Sebastian Raschka <sebastianraschka.com>
+#
+# License: BSD 3 clause
+
+from mlxtend.image import extract_face_landmarks
+
+
+def test_defaults():
+    extract_face_landmarks()

setup.py

@@ -47,9 +47,9 @@
              'Programming Language :: Python :: 2',
              'Programming Language :: Python :: 2.7',
              'Programming Language :: Python :: 3',
-             'Programming Language :: Python :: 3.3',
-             'Programming Language :: Python :: 3.4',
              'Programming Language :: Python :: 3.5',
+             'Programming Language :: Python :: 3.6',
+             'Programming Language :: Python :: 3.7',
              'Topic :: Scientific/Engineering',
              'Topic :: Scientific/Engineering :: Artificial Intelligence',
              'Topic :: Scientific/Engineering :: Information Analysis',