Merge branch 'docs' into 'main'

Docs Improvement

See merge request feta/wif-group/libwif!46

Author: plnyrich

include/wif/classifiers/classifier.hpp

@@ -40,17 +40,18 @@ class Classifier {
 
 	/**
 	 * @brief Perform classification of one flow
+	 * Only flowFeatures fields set by setFeatureSourceIDs() are processed
 	 *
 	 * @param flowFeatures flow features to classify
-	 * @return double classification result
+	 * @return ClfResult classification result
 	 */
 	virtual ClfResult classify(const FlowFeatures& flowFeatures) = 0;
 
 	/**
 	 * @brief Perform classification of burst of flows
 	 *
 	 * @param burstOfFlowFeatures burst of flow features to classify
-	 * @return std::vector<double> classification results
+	 * @return std::vector<ClfResult> classification results
 	 */
 	virtual std::vector<ClfResult> classify(const std::vector<FlowFeatures>& burstOfFlowFeatures)
 		= 0;

include/wif/classifiers/ipPrefixClassifier.hpp

@@ -48,8 +48,10 @@ class IpPrefixClassifier : public Classifier {
 
 	/**
 	 * @brief Classify single flowFeature object
-	 * ClfResult contains non-zero double value if flowFeatures contained a field with IP from
-	 * blocklist, otherwise the double value is set to zero
+	 * Source fields of flowFeatures objects must hold a value of type WIF::IpAddress
+	 *
+	 * ClfResult contains a single non-zero double value if flowFeatures contained a field with IP
+	 * from blocklist, otherwise the double value is set to zero
 	 *
 	 * @param flowFeatures flow features to classify
 	 * @return ClfResult result of the classification

include/wif/classifiers/regexClassifier.hpp

@@ -36,17 +36,22 @@ class RegexClassifier : public Classifier {
 
 	/**
 	 * @brief Classify single flowFeature object
+	 * Source fields of flowFeatures objects must hold a value of type std::string
+	 * If more source fields is set, the sub-results are combined together by a Combinator obtained
+	 * in the constructor
+	 *
+	 * ClfResult contains a single double value obtained from the combinator
 	 *
 	 * @param flowFeatures
-	 * @return double
+	 * @return ClfResult
 	 */
 	ClfResult classify(const FlowFeatures& flowFeatures) override;
 
 	/**
 	 * @brief Classify a burst of flow features
 	 *
 	 * @param burstOfFlowsFeatures
-	 * @return std::vector<double>
+	 * @return std::vector<ClfResult>
 	 */
 	std::vector<ClfResult> classify(const std::vector<FlowFeatures>& burstOfFlowsFeatures) override;
 

include/wif/classifiers/scikitMlClassifier.hpp

@@ -50,17 +50,22 @@ class ScikitMlClassifier : public Classifier {
 
 	/**
 	 * @brief Classify single flowFeature object
+	 * Source fields of flowFeatures objects must hold a value of type double
+	 * Fields are passed to the ML model in the order of passed source feature IDs
+	 *
+	 * ClfResult contains std::vector<double> representing output of predict_proba() call
+	 * with probabilities of each class
 	 *
 	 * @param flowFeatures
-	 * @return double
+	 * @return ClfResult
 	 */
 	ClfResult classify(const FlowFeatures& flowFeatures) override;
 
 	/**
 	 * @brief Classify a burst of flow features
 	 *
 	 * @param burstOfFlowsFeatures
-	 * @return std::vector<double>
+	 * @return std::vector<ClfResult>
 	 */
 	std::vector<ClfResult> classify(const std::vector<FlowFeatures>& burstOfFlowsFeatures) override;
 

include/wif/combinators/binaryDSTCombinator.hpp

@@ -31,7 +31,7 @@ class BinaryDSTCombinator : public Combinator {
 	 * together and the resulting probability of the positive hypothesis is returned.
 	 *
 	 * @param valuesToCombine vector of doubles to combine
-	 * @return double DST combination of input values
+	 * @return double belief of the positive hypothesis after DST combination
 	 */
 	double combine(const std::vector<double>& valuesToCombine) override;
 };