Quartus Streaming GRU

Author: bo3z

hls4ml/templates/quartus/firmware/nnet_utils/nnet_recurrent_stream.h

@@ -1,10 +1,67 @@
-/*
-*   PLACEHOLDER - TODO - Implement once PR #557 is merged
-*/
-
 #ifndef NNET_RECURRENT_STREAM_H_
 #define NNET_RECURRENT_STREAM_H_
 
-namespace nnet {}
+#include "nnet_common.h"
+#include "nnet_dense.h"
+#include "nnet_recurrent_activation.h"
+
+namespace nnet {
+template<class data_T, class res_T, typename CONFIG_T>
+void gru(
+    stream<data_T> &data_stream,
+    stream<res_T>  &res_stream,
+    const typename CONFIG_T::weight_t weights[3 * CONFIG_T::n_units * CONFIG_T::n_in],
+    const typename CONFIG_T::weight_t recurrent_weights[3 * CONFIG_T::n_units * CONFIG_T::n_units],
+    const typename CONFIG_T::bias_t bias[3 * CONFIG_T::n_units],
+    const typename CONFIG_T::bias_t recurrent_bias[3 * CONFIG_T::n_units]
+) {
+
+    hls_register typename res_T::value_type h[CONFIG_T::n_units];
+    #pragma unroll
+    for(int i = 0; i < CONFIG_T::n_units; i++) {
+        h[i] = 0;
+    }
+
+    hls_register typename data_T::value_type x[CONFIG_T::n_in];
+
+    DataPropagation: 
+    for(int i_in = 0; i_in < CONFIG_T::n_timesteps * CONFIG_T::n_in / data_T::size; i_in++) {
+        data_T data_pack = data_stream.read();
+      
+        DataPack: 
+        #pragma unroll
+        for (int i_pack = 0; i_pack < data_T::size; i_pack++) {
+            x[i_pack] = data_pack[i_pack];
+        }
+      
+        nnet::gru_cell<typename data_T::value_type, typename res_T::value_type, CONFIG_T>(x, h, weights, recurrent_weights, bias, recurrent_bias);
+
+        if (CONFIG_T::return_sequences) {
+            res_T res_pack;
+            
+            ResPackRetSeq: 
+            #pragma unroll
+            for (int i_pack = 0; i_pack < res_T::size; i_pack++) {
+                res_pack[i_pack] = h[i_pack];
+            }
+
+            res_stream.write(res_pack); 
+        }
+    }
+
+    if (!CONFIG_T::return_sequences) {
+        res_T res_pack;
+        
+        ResPackNoRetSeq: 
+        #pragma unroll
+        for (int i_pack = 0; i_pack < res_T::size; i_pack++) {
+            res_pack[i_pack] = h[i_pack];
+        }
+        
+        res_stream.write(res_pack); 
+    }
+}
+
+}
 
 #endif

test/pytest/test_rnn.py

@@ -69,6 +69,7 @@ def test_rnn_parsing(rnn_layer, return_sequences):
                             (GRU, 'Vivado', 'io_parallel'), 
                             (GRU, 'Vivado', 'io_stream'),
                             (GRU, 'Quartus', 'io_parallel'), 
+                            (GRU, 'Quartus', 'io_stream'), 
                         ])
 @pytest.mark.parametrize('return_sequences', [True, False])
 @pytest.mark.parametrize('static', [True, False])