From 8996d5e519f7d4e0c936091a010bb332dc41bdab Mon Sep 17 00:00:00 2001 From: snakers41 Date: Tue, 15 Dec 2020 14:51:16 +0000 Subject: [PATCH] Update readme, add skeleton for FAQ --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f073463..392c277 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,11 @@ - [Metrics](#metrics) - [Performance Metrics](#performance-metrics) - [Quality Metrics](#quality-metrics) + - [FAQ](#faq) + - [How VAD Works](#how-vad-works) + - [VAD Quality Metrics Methodology](#vad-quality-metrics-methodology) + - [How Number Detector Works](#how-number-detector-works) + - [How Language Classifier Works](#how-language-classifier-works) - [Contact](#contact) - [Get in Touch](#get-in-touch) - [Commercial Inquiries](#commercial-inquiries) @@ -57,7 +62,7 @@ Currently we provide the following functionality: | Version | Date | Comment | |---------|-------------|---------------------------------------------------| -| `v1` | 2020-12-15 | initial release | +| `v1` | 2020-12-15 | Initial release | | `v2` | coming soon | Add Number Detector or Language Classifier heads | ### PyTorch @@ -90,6 +95,24 @@ Speed metrics here. Quality metrics here. +## FAQ + +### How VAD Works + +Bla-bla, 300ms, 15ms latency on 1 thread, see examples (naive, streaming). + +### VAD Quality Metrics Methodology + +TBD + +### How Number Detector Works + +TBD + +### How Language Classifier Works + +TBD + ## Contact ### Get in Touch