[docs] order ipython notebooks

RazvanRanca · Sep 19, 2014 · dbf3c48 · dbf3c48
1 parent d5d75c9
commit dbf3c48
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 7 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -58,7 +58,7 @@ Developer documentation automagically generated from code comments.
 
 ### Notebook examples
 
-{% assign notebooks = site.pages | where:'category','notebook' %}
+{% assign notebooks = site.pages | where:'category','notebook' | sort: 'priority' %}
 {% for page in notebooks %}
 - <div><a href="http://nbviewer.ipython.org/github/BVLC/caffe/blob/master/{{page.original_path}}">{{page.title}}</a><br>{{page.description}}</div>
 {% endfor %}

diff --git a/examples/classification.ipynb b/examples/classification.ipynb
@@ -2,7 +2,8 @@
  "metadata": {
   "description": "Use the pre-trained ImageNet model to classify images with the Python interface.",
   "example_name": "ImageNet classification",
-  "include_in_docs": true
+  "include_in_docs": true,
+  "priority": 1
  },
  "nbformat": 3,
  "nbformat_minor": 0,

diff --git a/examples/detection.ipynb b/examples/detection.ipynb
@@ -2,7 +2,8 @@
  "metadata": {
   "description": "Run a pretrained model as a detector in Python.",
   "example_name": "R-CNN detection",
-  "include_in_docs": true
+  "include_in_docs": true,
+  "priority": 3
  },
  "nbformat": 3,
  "nbformat_minor": 0,

diff --git a/examples/filter_visualization.ipynb b/examples/filter_visualization.ipynb
@@ -2,7 +2,8 @@
  "metadata": {
   "description": "Extracting features and visualizing trained filters with an example image, viewed layer-by-layer.",
   "example_name": "Filter visualization",
-  "include_in_docs": true
+  "include_in_docs": true,
+  "priority": 2
  },
  "nbformat": 3,
  "nbformat_minor": 0,

diff --git a/examples/hdf5_classification.ipynb b/examples/hdf5_classification.ipynb
@@ -1,8 +1,9 @@
 {
  "metadata": {
   "description": "Use Caffe as a generic SGD optimizer to train logistic regression on non-image HDF5 data.",
-  "example_name": "Classification with HDF5 data",
+  "example_name": "Off-the-shelf SGD for classification",
   "include_in_docs": true,
+  "priority": 4,
   "signature": "sha256:c3b84add3bb83e91137f396a48f46d46bf7921b242fc42c58390b30806e5a028"
  },
  "nbformat": 3,
@@ -943,4 +944,4 @@
    "metadata": {}
   }
  ]
-}
+}
diff --git a/examples/net_surgery.ipynb b/examples/net_surgery.ipynb
@@ -3,6 +3,7 @@
   "description": "How to do net surgery and manually change model parameters, making a fully-convolutional classifier for dense feature extraction.",
   "example_name": "Editing model parameters",
   "include_in_docs": true,
+  "priority": 5,
   "signature": "sha256:179fb20339497f5e64f6fbeb57987f27a962b7ae6d940c8fede2631aba9bffaf"
  },
  "nbformat": 3,
@@ -351,4 +352,4 @@
    "metadata": {}
   }
  ]
-}
+}