- softmax is possibly a bit better

- readme

Author: pfeatherstone

README.md

@@ -1,2 +1,25 @@
+![Ubuntu](https://github.com/pfeatherstone/hubert.cpp/actions/workflows/ubuntu.yml/badge.svg)
+
 # hubert.cpp
-C++ implementation of DistilHuBERT
+
+C++ implementation of [DistilHuBERT](https://arxiv.org/pdf/2110.01900) using [Eigen](https://gitlab.com/libeigen/eigen).
+
+## Example
+
+```cpp
+hubert::model net;
+
+float audio[16000]; // 16kHz mono audio
+std::span<const float> feats = net.encode(audio); // [T,768] : an array of 768 packed normalized features
+```
+
+## Features
+
+- [x] Dynamic sizes (but no batches)
+- [x] Weights compiled into the library
+- [x] Block-based API
+- [ ] Streaming API.
+
+## Usage
+
+- Useful for downstream tasks such as speech representation, speaker identification, classification, etc.

src/lib/hubert.cpp

@@ -278,14 +278,6 @@ namespace hubert
         return x;
     }
 
-    template <class Derived>
-    auto softmax(const Eigen::ArrayBase<Derived>& x)
-    {
-        const float m = x.maxCoeff();
-        const auto e = (x - m).exp().eval();
-        return (e / e.sum()).eval();
-    }
-
 //----------------------------------------------------------------------------------------------------------------
 
     struct pos_embedding
@@ -373,7 +365,9 @@ namespace hubert
                 for (size_t t{0}; t < T; ++t)
                 {
                     auto row = scores.row(t).array();
-                    row = softmax(row);
+                    const float m = row.maxCoeff();
+                    row = (row - m).exp();
+                    row /= row.sum();
                 }
 
                 Oh.noalias() = scores * Vh;