feat: documents metric functions

src/metrics/recall.rs

@@ -1,12 +1,35 @@
+//! # Recall score
+//!
+//! How many relevant items are selected?
+//!
+//! \\[recall = \frac{tp}{tp + fn}\\]
+//!
+//! where tp (true positive) - correct result, fn (false negative) - missing result
+//!
+//! Example:
+//!
+//! ```
+//! use smartcore::metrics::recall::Recall;
+//! let y_pred: Vec<f64> = vec![0., 1., 1., 0.];
+//! let y_true: Vec<f64> = vec![0., 0., 1., 1.];
+//!
+//! let score: f64 = Recall {}.get_score(&y_pred, &y_true);
+//! ```
+//!
+//! <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS_CHTML"></script>
 use serde::{Deserialize, Serialize};
 
 use crate::linalg::BaseVector;
 use crate::math::num::RealNumber;
 
+/// Recall metric.
 #[derive(Serialize, Deserialize, Debug)]
 pub struct Recall {}
 
 impl Recall {
+    /// Calculated recall score
+    /// * `y_true` - cround truth (correct) labels.
+    /// * `y_pred` - predicted labels, as returned by a classifier.
     pub fn get_score<T: RealNumber, V: BaseVector<T>>(&self, y_true: &V, y_pred: &V) -> T {
         if y_true.len() != y_pred.len() {
             panic!(