Merge pull request #11 from christianversloot/add-warning-log

Add warning log to datasets

Author: christianversloot

.gitignore

@@ -1,3 +1,4 @@
 __pycache__/
 dist/
-build/
+build/
+test.py

extra_keras_datasets/emnist.py

@@ -18,6 +18,21 @@
 from zipfile import ZipFile
 from scipy import io as sio
 import os
+import logging
+
+
+def warn_citation():
+    """Warns about citation requirements
+    # Returns
+      Void
+    """
+    logging.warning(("Please cite the following paper when using or"
+                     " referencing this Extra Keras Dataset:"))
+    logging.warning(
+        ("Cohen, G., Afshar, S., Tapson, J., & van Schaik, A. (2017). EMNIST: "
+         "an extension of MNIST to handwritten letters. "
+         "Retrieved from http://arxiv.org/abs/1702.05373")
+      )
 
 
 def load_data(path="emnist_matlab.npz", type="balanced"):
@@ -64,5 +79,8 @@ def load_data(path="emnist_matlab.npz", type="balanced"):
           (input_test.shape[0], 28, 28), order="F"
         )
 
+        # Warn about citation
+        warn_citation()
+
         # Return data
         return (input_train, target_train), (input_test, target_test)

extra_keras_datasets/iris.py

@@ -14,6 +14,22 @@
 from tensorflow.keras.utils import get_file
 import numpy as np
 import math
+import logging
+
+
+def warn_citation():
+    """Warns about citation requirements
+    # Returns
+      Void
+    """
+    logging.warning(("Please cite the following paper when using or"
+                     " referencing this Extra Keras Dataset:"))
+    logging.warning(
+        ("Fisher,R.A. \"The use of multiple measurements in taxonomic "
+         "problems\" Annual Eugenics, 7, Part II, 179-188 (1936); also "
+         "in \"Contributions to Mathematical Statistics\" (John Wiley"
+         ", NY, 1950).")
+      )
 
 
 def load_data(path="iris.npz", test_split=0.2):
@@ -64,6 +80,9 @@ def load_data(path="iris.npz", test_split=0.2):
     target_train = [i[4] for i in training_data]
     target_test = [i[4] for i in testing_data]
 
+    # Warn about citation
+    warn_citation()
+
     # Return data
     return (input_train, target_train), (input_test, target_test)
 

extra_keras_datasets/kmnist.py

@@ -14,6 +14,22 @@
 
 from tensorflow.keras.utils import get_file
 import numpy as np
+import logging
+
+
+def warn_citation():
+    """Warns about citation requirements
+    # Returns
+      Void
+    """
+    logging.warning(("Please cite the following paper when using or"
+                     " referencing this Extra Keras Dataset:"))
+    logging.warning(
+        ("Clanuwat, T., Bober-Irizar, M., Kitamoto, A., Lamb, A., "
+         "Yamamoto, K., & Ha, D. (2018). Deep learning for classical "
+         "Japanese literature arXiv preprint arXiv:1812.01718. "
+         "Retrieved from https://arxiv.org/abs/1812.01718")
+      )
 
 
 def load_data(path="kmnist.npz", type="kmnist"):
@@ -58,5 +74,8 @@ def load_data(path="kmnist.npz", type="kmnist"):
     )
     target_test = np.load(path_test_labels)["arr_0"]
 
+    # Warn about citation
+    warn_citation()
+
     # Return data
     return (input_train, target_train), (input_test, target_test)

extra_keras_datasets/stl10.py

@@ -19,6 +19,23 @@
 from scipy import io as sio
 import shutil
 import numpy as np
+import logging
+
+
+def warn_citation():
+    """Warns about citation requirements
+    # Returns
+      Void
+    """
+    logging.warning(("Please cite the following paper when using or"
+                     " referencing this Extra Keras Dataset:"))
+    logging.warning(
+        ("Coates, A., Ng, A., & Lee, H. (2011, June). An analysis of single-"
+         "layer networks in unsupervised feature learning. In Proceedings of"
+         " the fourteenth international conference on artificial "
+         "intelligence and statistics (pp. 215-223).Retrieved from "
+         "http://cs.stanford.edu/~acoates/papers/coatesleeng_aistats_2011.pdf")
+      )
 
 
 def load_data(path="stl10_matlab.tar.gz"):
@@ -59,5 +76,8 @@ def load_data(path="stl10_matlab.tar.gz"):
     input_test = np.transpose(input_test, (0, 3, 2, 1))
     target_test = test["y"].flatten()
 
+    # Warn about citation
+    warn_citation()
+
     # Return data
     return (input_train, target_train), (input_test, target_test)

extra_keras_datasets/svhn.py

@@ -16,6 +16,25 @@
 from tensorflow.keras.utils import get_file
 import numpy as np
 from scipy import io as sio
+import logging
+
+
+def warn_citation():
+    """Warns about citation requirements
+    # Returns
+      Void
+    """
+    logging.warning(("Please cite the following paper when using or"
+                     " referencing this Extra Keras Dataset:"))
+    logging.warning(
+        ("Yuval Netzer, Tao Wang, Adam Coates, Alessandro Bissacco, Bo Wu, "
+         "Andrew Y. Ng Reading Digits in Natural Images with Unsupervised "
+         "Feature Learning NIPS Workshop on Deep Learning and Unsupervised "
+         "Feature Learning 2011. Retrieved from "
+         "http://ufldl.stanford.edu/housenumbers/nips2011_housenumbers.pdf")
+      )
+    logging.warning(("Noncommercial use is allowed only: see the "
+                     "SVHN website for more information."))
 
 
 def load_data(path="svhn_matlab.npz", type="normal"):
@@ -66,5 +85,8 @@ def load_data(path="svhn_matlab.npz", type="normal"):
         input_train = np.concatenate((input_extra, input_train))
         target_train = np.concatenate((target_extra, target_train))
 
+    # Warn about citation
+    warn_citation()
+
     # Return data
     return (input_train, target_train), (input_test, target_test)