Add model metrics to docstrings (#145)

Co-authored-by: Lukas Geiger <[email protected]>

Author: michaeltinsley

larq_zoo/literature/binary_alex_net.py

@@ -128,6 +128,12 @@ def BinaryAlexNet(
     /plots/binary_alexnet.vg.json
     ```
 
+    # ImageNet Metrics
+
+    | Top-1 Accuracy | Top-5 Accuracy | Parameters | Memory  |
+    | -------------- | -------------- | ---------- | ------- |
+    | 36.30 %        | 61.53 %        | 61 859 192 | 7.49 MB |
+
     # Arguments
     input_shape: Optional shape tuple, to be specified if you would like to use a model
         with an input image resolution that is not (224, 224, 3).

larq_zoo/literature/birealnet.py

@@ -134,6 +134,12 @@ def BiRealNet(
     /plots/birealnet.vg.json
     ```
 
+    # ImageNet Metrics
+
+    | Top-1 Accuracy | Top-5 Accuracy | Parameters | Memory  |
+    | -------------- | -------------- | ---------- | ------- |
+    | 57.47 %        | 79.84 %        | 11 699 112 | 4.03 MB |
+
     # Arguments
     input_shape: Optional shape tuple, to be specified if you would like to use a model
         with an input image resolution that is not (224, 224, 3).

larq_zoo/literature/densenet.py

@@ -248,6 +248,12 @@ def BinaryDenseNet28(
     /plots/densenet_28.vg.json
     ```
 
+    # ImageNet Metrics
+
+    | Top-1 Accuracy | Top-5 Accuracy | Parameters | Memory  |
+    | -------------- | -------------- | ---------- | ------- |
+    | 60.91 %        | 82.83 %        | 5 150 504  | 4.12 MB |
+
     # Arguments
     input_shape: Optional shape tuple, to be specified if you would like to use a model
         with an input image resolution that is not (224, 224, 3).
@@ -298,6 +304,12 @@ def BinaryDenseNet37(
     /plots/densenet_37.vg.json
     ```
 
+    # ImageNet Metrics
+
+    | Top-1 Accuracy | Top-5 Accuracy | Parameters | Memory  |
+    | -------------- | -------------- | ---------- | ------- |
+    | 62.89 %        | 84.19 %        | 8 734 120  | 5.25 MB |
+
     # Arguments
     input_shape: Optional shape tuple, to be specified if you would like to use a model
         with an input image resolution that is not (224, 224, 3).
@@ -348,6 +360,12 @@ def BinaryDenseNet37Dilated(
     /plots/densenet_37_dilated.vg.json
     ```
 
+    # ImageNet Metrics
+
+    | Top-1 Accuracy | Top-5 Accuracy | Parameters | Memory  |
+    | -------------- | -------------- | ---------- | ------- |
+    | 64.34 %        | 85.15 %        | 8 734 120  | 5.25 MB |
+
     # Arguments
     input_shape: Optional shape tuple, to be specified if you would like to use a model
         with an input image resolution that is not (224, 224, 3).
@@ -398,6 +416,12 @@ def BinaryDenseNet45(
     /plots/densenet_45.vg.json
     ```
 
+    # ImageNet Metrics
+
+    | Top-1 Accuracy | Top-5 Accuracy | Parameters | Memory  |
+    | -------------- | -------------- | ---------- | ------- |
+    | 64.59 %        | 85.21 %        | 13 939 240 | 7.54 MB |
+
     # Arguments
     input_shape: Optional shape tuple, to be specified if you would like to use a model
         with an input image resolution that is not (224, 224, 3).

larq_zoo/literature/dorefanet.py

@@ -141,6 +141,12 @@ def DoReFaNet(
     /plots/dorefanet.vg.json
     ```
 
+    # ImageNet Metrics
+
+    | Top-1 Accuracy | Top-5 Accuracy | Parameters | Memory  |
+    | -------------- | -------------- | ---------- | ------- |
+    | 53.39 %        | 76.50 %        | 62 403 912 | 22.84 MB |
+
     # Arguments
     input_shape: Optional shape tuple, to be specified if you would like to use a model
         with an input image resolution that is not (224, 224, 3).

larq_zoo/literature/resnet_e.py

@@ -154,6 +154,12 @@ def BinaryResNetE18(
     /plots/resnet_e_18.vg.json
     ```
 
+    # ImageNet Metrics
+
+    | Top-1 Accuracy | Top-5 Accuracy | Parameters | Memory  |
+    | -------------- | -------------- | ---------- | ------- |
+    | 58.32 %        | 80.79 %        | 11 699 368 | 4.03 MB |
+
     # Arguments
     input_shape: Optional shape tuple, to be specified if you would like to use a model
         with an input image resolution that is not (224, 224, 3).

larq_zoo/literature/xnornet.py

@@ -148,6 +148,12 @@ def XNORNet(
     /plots/xnornet.vg.json
     ```
 
+    # ImageNet Metrics
+
+    | Top-1 Accuracy | Top-5 Accuracy | Parameters | Memory  |
+    | -------------- | -------------- | ---------- | ------- |
+    | 44.96 %        | 69.18 %        | 62 396 768 | 22.81 MB |
+
     # Arguments
     input_shape: Optional shape tuple, to be specified if you would like to use a model
         with an input image resolution that is not (224, 224, 3).

larq_zoo/sota/quicknet.py

@@ -305,6 +305,12 @@ def QuickNet(
     quicknet-v0.2.0/quicknet.json
     ```
 
+    # ImageNet Metrics
+
+    | Top-1 Accuracy | Top-5 Accuracy | Parameters | Memory  |
+    | -------------- | -------------- | ---------- | ------- |
+    | 58.6 %         | 81.0 %         | 10 518 528 | 3.21 MB |
+
     # Arguments
     input_shape: Optional shape tuple, to be specified if you would like to use a model
         with an input image resolution that is not (224, 224, 3).
@@ -348,6 +354,12 @@ def QuickNetLarge(
     quicknet_large-v0.2.0/quicknet_large.json
     ```
 
+    # ImageNet Metrics
+
+    | Top-1 Accuracy | Top-5 Accuracy | Parameters | Memory  |
+    | -------------- | -------------- | ---------- | ------- |
+    | 62.7 %         | 84.0 %         | 11 837 696 | 4.56 MB |
+
     # Arguments
     input_shape: Optional shape tuple, to be specified if you would like to use a model
         with an input image resolution that is not (224, 224, 3).
@@ -391,6 +403,12 @@ def QuickNetXL(
     quicknet_xl-v0.1.0/quicknet_xl.json
     ```
 
+    # ImageNet Metrics
+
+    | Top-1 Accuracy | Top-5 Accuracy | Parameters | Memory  |
+    | -------------- | -------------- | ---------- | ------- |
+    | 67.0 %         | 87.3 %         | 22 058 368 | 6.22 MB |
+
     # Arguments
     input_shape: Optional shape tuple, to be specified if you would like to use a model
         with an input image resolution that is not (224, 224, 3).