Update readme, add skeleton for FAQ

This commit is contained in:
snakers41
2020-12-15 14:51:16 +00:00
parent 62e0346360
commit 8996d5e519

View File

@@ -13,6 +13,11 @@
- [Metrics](#metrics) - [Metrics](#metrics)
- [Performance Metrics](#performance-metrics) - [Performance Metrics](#performance-metrics)
- [Quality Metrics](#quality-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) - [Contact](#contact)
- [Get in Touch](#get-in-touch) - [Get in Touch](#get-in-touch)
- [Commercial Inquiries](#commercial-inquiries) - [Commercial Inquiries](#commercial-inquiries)
@@ -57,7 +62,7 @@ Currently we provide the following functionality:
| Version | Date | Comment | | 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 | | `v2` | coming soon | Add Number Detector or Language Classifier heads |
### PyTorch ### PyTorch
@@ -90,6 +95,24 @@ Speed metrics here.
Quality 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 ## Contact
### Get in Touch ### Get in Touch