Add faqs (#36)

KarelZe · Dec 22, 2023 · 40377dc · 40377dc
1 parent c1eefe1
commit 40377dc
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/faq.md b/docs/faq.md
@@ -0,0 +1,7 @@
+## Frequently Asked Questions
+
+**How are `NaN` values handled in by `tclf`?**
+
+We take care to treat `NaN` values correctly. If features relevant for classification like the trade price or quoted bid/ask prices are missing, no classification is performed and classification of the trade is deferred to the subsequent rule or fallback strategy.
+
+Alternatively, you can provide imputed data. See [`sklearn.impute`](https://scikit-learn.org/stable/modules/classes.html#module-sklearn.impute) for details.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -18,6 +18,7 @@ nav:
   - Home: index.md
   - API reference: reference.md
   - Naming conventions: naming_conventions.md
+  - FAQs: faq.md
 
 markdown_extensions:
   - toc: