Rename ml_frameworks.*, visualizations.base

jwayne · jwayne · commit b9cb2609bb72 · 2017-07-05T19:01:14.000+02:00
diff --git a/picasso/__init__.py b/picasso/__init__.py
@@ -13,7 +13,7 @@
     raise SystemError('Python 3.5+ required, found {}'.format(sys.version))
 
 app = Flask(__name__)
-app.config.from_object('picasso.settings.Default')
+app.config.from_object('picasso.config.Default')
 
 if os.getenv('PICASSO_SETTINGS'):
     app.config.from_envvar('PICASSO_SETTINGS')
diff --git a/picasso/config.py b/picasso/config.py
diff --git a/picasso/examples/keras-vgg16/model.py b/picasso/examples/keras-vgg16/model.py
@@ -1,11 +1,8 @@
-from keras.applications.imagenet_utils import (decode_predictions,
-                                               preprocess_input)
-import keras.applications.imagenet_utils
+from keras.applications import imagenet_utils
 import numpy as np
 from PIL import Image
 
-from picasso.ml_frameworks.keras.model import KerasModel
-
+from picasso.models.keras import KerasModel
 
 VGG16_DIM = (224, 224, 3)
 
@@ -27,18 +24,19 @@ def preprocess(self, raw_inputs):
             image_arrays.append(arr)
 
         all_raw_inputs = np.array(image_arrays)
-        return preprocess_input(all_raw_inputs)
+        return imagenet_utils.preprocess_input(all_raw_inputs)
 
     def decode_prob(self, class_probabilities):
-        r = decode_predictions(class_probabilities, top=self.top_probs)
+        r = imagenet_utils.decode_predictions(class_probabilities,
+                                              top=self.top_probs)
         results = [
             [{'code': entry[0],
               'name': entry[1],
               'prob': '{:.3f}'.format(entry[2])}
              for entry in row]
             for row in r
         ]
-        classes = keras.applications.imagenet_utils.CLASS_INDEX
+        classes = imagenet_utils.CLASS_INDEX
         class_keys = list(classes.keys())
         class_values = list(classes.values())
 
diff --git a/picasso/examples/keras/model.py b/picasso/examples/keras/model.py
@@ -1,8 +1,7 @@
 import numpy as np
 from PIL import Image
 
-from picasso.ml_frameworks.keras.model import KerasModel
-
+from picasso.models.keras import KerasModel
 
 MNIST_DIM = (28, 28)
 
diff --git a/picasso/examples/tensorflow/model.py b/picasso/examples/tensorflow/model.py
@@ -1,8 +1,7 @@
 import numpy as np
 from PIL import Image
 
-from picasso.ml_frameworks.tensorflow.model import TFModel
-
+from picasso.models.tensorflow import TFModel
 
 MNIST_DIM = (28, 28)
 
diff --git a/picasso/ml_frameworks/keras/__init__.py b/picasso/ml_frameworks/keras/__init__.py
diff --git a/picasso/ml_frameworks/tensorflow/__init__.py b/picasso/ml_frameworks/tensorflow/__init__.py
diff --git a/picasso/models/__init__.py b/picasso/models/__init__.py
diff --git a/picasso/models/base.py b/picasso/models/base.py
@@ -14,7 +14,7 @@ def load_model(model_cls_path, model_cls_name, model_load_args):
             of the model instance.
 
     Returns:
-        An instance of :class:`.ml_frameworks.model.BaseModel` or subclass
+        An instance of :class:`.models.model.BaseModel` or subclass
 
     """
     spec = importlib.util.spec_from_file_location('active_model',
diff --git a/picasso/models/keras.py b/picasso/models/keras.py
@@ -6,7 +6,7 @@
 import keras.backend as K
 from keras.models import model_from_json, load_model
 
-from picasso.ml_frameworks.model import BaseModel
+from picasso.models.base import BaseModel
 
 
 class KerasModel(BaseModel):
diff --git a/picasso/models/tensorflow.py b/picasso/models/tensorflow.py
@@ -4,7 +4,7 @@
 
 import tensorflow as tf
 
-from picasso.ml_frameworks.model import BaseModel
+from picasso.models.base import BaseModel
 
 
 class TFModel(BaseModel):
diff --git a/picasso/picasso.py b/picasso/picasso.py
@@ -21,18 +21,18 @@
 Attributes:
     APP_TITLE (:obj:`str`): Name of the application to display in the
         title bar
-    VISUALIZATON_CLASSES(:obj:`tuple` of :class:`.BaseVisualization`):
+    VISUALIZATION_CLASSES (:obj:`tuple` of :class:`.BaseVisualization`):
         Visualization classes available for rendering.
 
 """
-import os
-import io
-import time
+from importlib import import_module
 import inspect
-import shutil
+import io
+import os
 from operator import itemgetter
+import shutil
 from tempfile import mkdtemp
-from importlib import import_module
+import time
 from types import ModuleType
 
 from PIL import Image
@@ -46,39 +46,50 @@
 )
 from werkzeug.utils import secure_filename
 
-from picasso import app
 from picasso import __version__
-from picasso.ml_frameworks.model import load_model
-from picasso.visualizations import BaseVisualization
+from picasso import app
+from picasso.models.base import load_model
 from picasso.visualizations import *
+from picasso.visualizations.base import BaseVisualization
 
 APP_TITLE = 'Picasso Visualizer'
 
-# import visualizations classes dynamically
-visualization_attr = vars(
-    import_module('picasso.visualizations'))
-visualization_submodules = [visualization_attr[x] for x in visualization_attr
-                            if isinstance(visualization_attr[x], ModuleType)]
-VISUALIZATON_CLASSES = []
-for submodule in visualization_submodules:
-    members = vars(submodule)
-    classes = [members[x] for x in members if inspect.isclass(members[x]) and
-               issubclass(members[x], BaseVisualization) and
-               members[x] is not BaseVisualization]
-    VISUALIZATON_CLASSES += classes
-
-# Use a bogus secret key for debugging ease. No
-# client information is stored, the secret key is only
-# necessary for generating the session cookie.
+
+def _get_visualization_classes():
+    """Import visualizations classes dynamically
+
+    """
+    visualization_attr = vars(
+        import_module('picasso.visualizations'))
+    visualization_submodules = [
+        visualization_attr[x]
+        for x in visualization_attr
+        if isinstance(visualization_attr[x], ModuleType)]
+
+    visualization_classes = []
+    for submodule in visualization_submodules:
+        attrs = vars(submodule)
+        for attr_name in attrs:
+            attr = attrs[attr_name]
+            if (inspect.isclass(attr)
+                and issubclass(attr, BaseVisualization)
+                and attr is not BaseVisualization):
+                visualization_classes.append(attr)
+    return visualization_classes
+
+
+VISUALIZATION_CLASSES = _get_visualization_classes()
+
+# Use a bogus secret key for debugging ease. No client information is stored;
+# the secret key is only necessary for generating the session cookie.
 if app.debug:
     app.secret_key = '...'
 else:
     app.secret_key = os.urandom(24)
 
-# This pattern is used in other projects with Flask and
-# tensorflow, but probably isn't the most stable or
-# safest way.  Would be much better to connect to a
-# persistent tensorflow session running in another process or
+# This pattern is used in other projects with Flask and Tensorflow, but
+# but probably isn't the most stable or safest way.  Would be much better to
+# connect to a persistent Tensorflow session running in another process or
 # machine.
 model = load_model(app.config['MODEL_CLS_PATH'], app.config['MODEL_CLS_NAME'],
                    app.config['MODEL_LOAD_ARGS'])
@@ -111,7 +122,7 @@ def get_model():
     the model in the request context if it is not yet there.
 
     Returns:
-        instance of :class:`.ml_frameworks.model.Model` or derived
+        instance of :class:`.models.model.Model` or derived
         class
     """
     if not hasattr(g, 'model'):
@@ -130,7 +141,7 @@ def get_visualizations():
     """
     if not hasattr(g, 'visualizations'):
         g.visualizations = {}
-        for VisClass in VISUALIZATON_CLASSES:
+        for VisClass in VISUALIZATION_CLASSES:
             vis = VisClass(get_model())
             g.visualizations[vis.__class__.__name__] = vis
 
diff --git a/picasso/templates/layout.html b/picasso/templates/layout.html
@@ -12,7 +12,7 @@
 </head>
 
 <div class="container-fluid">
-	<h1><a href="https://github.com/merantix/picasso">{{ app_state.app_title }}</a>
+  <h1><a href="{{ url_for('landing') }}">{{ app_state.app_title }}</a>
 		<small class="text-muted"> by
 		 	<a href="http://www.merantix.com">Merantix</a>
 		</small>
diff --git a/picasso/visualizations/__init__.py b/picasso/visualizations/__init__.py
@@ -6,63 +6,6 @@
 
 """
 import os
+
 __all__ = [x.rpartition('.')[0] for x in os.listdir(__path__[0])
            if not x.startswith('__') and x.endswith('py')]
-
-
-class BaseVisualization:
-    """Interface encapsulating a NN visualization.
-
-    This interface defines how a visualization is computed for a given NN
-    model.
-
-    """
-    # (:obj:`str`): Short description of the visualization.
-    DESCRIPTION = None
-
-    # (:obj:`str`): Optional link to the paper specifying the visualization.
-    REFERENCE_LINK = None
-
-    # (:obj:`dict`): Optional visuzalization settings that the user can select.
-    # Should be a dict mapping setting names to lists of their allowed values.
-    ALLOWED_SETTINGS = None
-
-    def __init__(self, model):
-        """Create a new instance of this visualization.
-
-        `BaseVisualization` is an interface and should only be instantiated via
-        a subclass.
-
-        Args:
-            model (:obj:`.ml_frameworks.model.BaseModel`): NN model to be
-                visualized.
-
-        """
-        self._model = model
-
-    @property
-    def model(self):
-        """NN model to be visualized.
-
-        (:obj:`.ml_frameworks.model.BaseModel`)
-
-        """
-        return self._model
-
-    def make_visualization(self, inputs, output_dir, settings=None):
-        """Generate the visualization.
-
-        All visualizations must implement this method.
-
-        Args:
-            inputs (iterable of :class:`PIL.Image`): Batch of input images to
-                make visualizations for, as PIL :obj:`Image` objects.
-            output_dir (:obj:`str`): A directory to write outputs (e.g.,
-                plots) to.
-
-        Returns:
-            data needed to render the visualization.  Since there is an
-            associated HTML template, the return type is arbitrary.
-
-        """
-        raise NotImplementedError
diff --git a/picasso/visualizations/base.py b/picasso/visualizations/base.py
@@ -0,0 +1,62 @@
+class BaseVisualization:
+    """Interface encapsulating a NN visualization.
+
+    This interface defines how a visualization is computed for a given NN
+    model.
+
+    """
+    # (:obj:`str`): Short description of the visualization.
+    DESCRIPTION = None
+
+    # (:obj:`str`): Optional link to the paper specifying the visualization.
+    REFERENCE_LINK = None
+
+    # (:obj:`dict`): Optional visualization settings that the user can select,
+    # as a dict mapping setting names to lists of their allowed values.
+    ALLOWED_SETTINGS = None
+
+    def __init__(self, model):
+        """Create a new instance of this visualization.
+
+        `BaseVisualization` is an interface and should only be instantiated via
+        a subclass.
+
+        Args:
+            model (:obj:`.models.model.BaseModel`): NN model to be
+                visualized.
+
+        """
+        self._model = model
+
+    @property
+    def model(self):
+        """NN model to be visualized.
+
+        (:obj:`.models.model.BaseModel`)
+
+        """
+        return self._model
+
+    def make_visualization(self, inputs, output_dir, settings=None):
+        """Generate the visualization.
+
+        All visualizations must implement this method.
+
+        Args:
+            inputs (iterable of :class:`PIL.Image`): Batch of input images to
+                make visualizations for, as PIL :obj:`Image` objects.
+            output_dir (:obj:`str`): A directory to write outputs (e.g.,
+                plots) to.
+            settings (:obj:`str`): Dictionary of settings that the user
+                selected, as a dict mapping setting names to values.  This
+                should only be provided if this class's `ALLOWED_SETTINGS`
+                attribute is non-null.
+
+        Returns:
+            Object used to render the visualization, passed directly to the
+            visualization class's associated HTML template.  Since this HTML
+            template is custom for each visualization class, the return type
+            is arbitrary.
+
+        """
+        raise NotImplementedError
diff --git a/picasso/visualizations/class_probabilities.py b/picasso/visualizations/class_probabilities.py
@@ -1,4 +1,4 @@
-from picasso.visualizations import BaseVisualization
+from picasso.visualizations.base import BaseVisualization
 
 
 class ClassProbabilities(BaseVisualization):
diff --git a/picasso/visualizations/partial_occlusion.py b/picasso/visualizations/partial_occlusion.py
@@ -8,7 +8,7 @@
 matplotlib.use('Agg')
 from matplotlib import pyplot
 
-from picasso.visualizations import BaseVisualization
+from picasso.visualizations.base import BaseVisualization
 
 
 class PartialOcclusion(BaseVisualization):
diff --git a/picasso/visualizations/saliency_maps.py b/picasso/visualizations/saliency_maps.py
@@ -8,7 +8,7 @@
 matplotlib.use('Agg')
 from matplotlib import pyplot
 
-from picasso.visualizations import BaseVisualization
+from picasso.visualizations.base import BaseVisualization
 
 
 class SaliencyMaps(BaseVisualization):
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -27,7 +27,7 @@ def example_prob_array():
 
 @pytest.fixture
 def base_model():
-    from picasso.ml_frameworks.model import BaseModel
+    from picasso.models.base import BaseModel
     class BaseModelForTest(BaseModel):
         def load(self, data_dir):
             pass
@@ -36,5 +36,5 @@ def load(self, data_dir):
 
 @pytest.fixture
 def tensorflow_model():
-    from picasso.ml_frameworks.tensorflow.model import TFModel
+    from picasso.models.tensorflow import TFModel
     return TFModel()
diff --git a/tests/test_picasso.py b/tests/test_picasso.py
