Render model summary in docs (#151)

larq · Apr 17, 2020 · 31d5b47 · 31d5b47
1 parent 84c43dc
commit 31d5b47
Show file tree

Hide file tree

Showing 7 changed files with 36 additions and 0 deletions.
diff --git a/larq_zoo/literature/binary_alex_net.py b/larq_zoo/literature/binary_alex_net.py
@@ -124,6 +124,9 @@ def BinaryAlexNet(
     ```netron
     binary_alexnet-v0.2.0/binary_alexnet.json
     ```
+    ```summary
+    literature.BinaryAlexNet
+    ```
     ```plot-altair
     /plots/binary_alexnet.vg.json
     ```

diff --git a/larq_zoo/literature/birealnet.py b/larq_zoo/literature/birealnet.py
@@ -130,6 +130,9 @@ def BiRealNet(
     ```netron
     birealnet-v0.3.0/birealnet.json
     ```
+    ```summary
+    literature.BiRealNet
+    ```
     ```plot-altair
     /plots/birealnet.vg.json
     ```

diff --git a/larq_zoo/literature/densenet.py b/larq_zoo/literature/densenet.py
@@ -244,6 +244,9 @@ def BinaryDenseNet28(
     ```netron
     binary_densenet-v0.1.0/binary_densenet_28.json
     ```
+    ```summary
+    literature.BinaryDenseNet28
+    ```
     ```plot-altair
     /plots/densenet_28.vg.json
     ```
@@ -300,6 +303,9 @@ def BinaryDenseNet37(
     ```netron
     binary_densenet-v0.1.0/binary_densenet_37.json
     ```
+    ```summary
+    literature.BinaryDenseNet37
+    ```
     ```plot-altair
     /plots/densenet_37.vg.json
     ```
@@ -356,6 +362,9 @@ def BinaryDenseNet37Dilated(
     ```netron
     binary_densenet-v0.1.0/binary_densenet_37_dilated.json
     ```
+    ```summary
+    literature.BinaryDenseNet37Dilated
+    ```
     ```plot-altair
     /plots/densenet_37_dilated.vg.json
     ```
@@ -412,6 +421,9 @@ def BinaryDenseNet45(
     ```netron
     binary_densenet-v0.1.0/binary_densenet_45.json
     ```
+    ```summary
+    literature.BinaryDenseNet45
+    ```
     ```plot-altair
     /plots/densenet_45.vg.json
     ```

diff --git a/larq_zoo/literature/dorefanet.py b/larq_zoo/literature/dorefanet.py
@@ -137,6 +137,9 @@ def DoReFaNet(
     ```netron
     dorefanet-v0.1.0/dorefanet.json
     ```
+    ```summary
+    literature.DoReFaNet
+    ```
     ```plot-altair
     /plots/dorefanet.vg.json
     ```

diff --git a/larq_zoo/literature/resnet_e.py b/larq_zoo/literature/resnet_e.py
@@ -150,6 +150,9 @@ def BinaryResNetE18(
     ```netron
     resnet_e-v0.1.0/resnet_e_18.json
     ```
+    ```summary
+    literature.BinaryResNetE18
+    ```
     ```plot-altair
     /plots/resnet_e_18.vg.json
     ```

diff --git a/larq_zoo/literature/xnornet.py b/larq_zoo/literature/xnornet.py
@@ -144,6 +144,9 @@ def XNORNet(
     ```netron
     xnornet-v0.2.0/xnornet.json
     ```
+    ```summary
+    literature.XNORNet
+    ```
     ```plot-altair
     /plots/xnornet.vg.json
     ```

diff --git a/larq_zoo/sota/quicknet.py b/larq_zoo/sota/quicknet.py
@@ -304,6 +304,9 @@ def QuickNet(
     ```netron
     quicknet-v0.2.0/quicknet.json
     ```
+    ```summary
+    sota.QuickNet
+    ```
 
     # ImageNet Metrics
 
@@ -353,6 +356,9 @@ def QuickNetLarge(
     ```netron
     quicknet_large-v0.2.0/quicknet_large.json
     ```
+    ```summary
+    sota.QuickNetLarge
+    ```
 
     # ImageNet Metrics
 
@@ -402,6 +408,9 @@ def QuickNetXL(
     ```netron
     quicknet_xl-v0.1.0/quicknet_xl.json
     ```
+    ```summary
+    sota.QuickNetXL
+    ```
 
     # ImageNet Metrics