Fix summary about models (keras-team#8245)

julienr · fchollet · commit e48bc45d1b4f · 2017-10-25T14:17:32.000-07:00
* Expose and document utils.layer_utils.print_summary as utils.print_summary Fixes keras-team#8105 * Fix docs autogen when running on python 3.6.2 When a class inherits from object without defining __init__, AttributeError is raised instead of TypeError. So we need to catch both exceptions to be compatible. * Fix process_XXX_docstring functions to work with models function The process_function_docstring would fail to parse the “# Argument” and “# Returns” of class functions. This was because it expected the “# Argument” string to be preceeded by exactly a newline and 4 spaces, but for class methods, that would be a newline and 8 spaces. This fixes the problem by expecting a newline and some number of space.
diff --git a/docs/autogen.py b/docs/autogen.py
@@ -284,6 +284,7 @@
         'functions': [utils.to_categorical,
                       utils.normalize,
                       utils.get_file,
+                      utils.print_summary,
                       utils.plot_model,
                       utils.multi_gpu_model],
         'classes': [utils.CustomObjectScope,
@@ -360,7 +361,7 @@ def get_class_signature(cls):
     try:
         class_signature = get_function_signature(cls.__init__)
         class_signature = class_signature.replace('__init__', cls.__name__)
-    except TypeError:
+    except (TypeError, AttributeError):
         # in case the class inherits from object and does not
         # define __init__
         class_signature = cls.__module__ + '.' + cls.__name__ + '()'
@@ -406,8 +407,8 @@ def code_snippet(snippet):
 
 
 def process_class_docstring(docstring):
-    docstring = re.sub(r'\n    # (.*)\n',
-                       r'\n    __\1__\n\n',
+    docstring = re.sub(r'\n(\s+)# (.*)\n',
+                       r'\n\1__\2__\n\n',
                        docstring)
     docstring = re.sub(r'    ([^\s\\\(]+):(.*)\n',
                        r'    - __\1__:\2\n',
@@ -420,8 +421,8 @@ def process_class_docstring(docstring):
 
 
 def process_function_docstring(docstring):
-    docstring = re.sub(r'\n    # (.*)\n',
-                       r'\n    __\1__\n\n',
+    docstring = re.sub(r'\n(\s+)# (.*)\n',
+                       r'\n\1__\2__\n\n',
                        docstring)
     docstring = re.sub(r'    ([^\s\\\(]+):(.*)\n',
                        r'    - __\1__:\2\n',
diff --git a/docs/templates/models/about-keras-models.md b/docs/templates/models/about-keras-models.md
@@ -4,7 +4,7 @@ There are two types of models available in Keras: [the Sequential model](/models
 
 These models have a number of methods in common:
 
-- `model.summary()`: prints a summary representation of your model.
+- `model.summary()`: prints a summary representation of your model. Shortcut for [utils.print_summary](/utils/#print_summary)
 - `model.get_config()`: returns a dictionary containing the configuration of the model. The model can be reinstantiated from its config via:
 ```python
 config = model.get_config()
diff --git a/keras/utils/__init__.py b/keras/utils/__init__.py
@@ -18,6 +18,7 @@
 from .generic_utils import deserialize_keras_object
 from .generic_utils import Progbar
 from .layer_utils import convert_all_kernels_in_model
+from .layer_utils import print_summary
 from .vis_utils import plot_model
 from .np_utils import to_categorical
 from .np_utils import normalize
