Fixed build: #100

Author: DavidIkov

knp/base-framework/include/knp/framework/data_processing/classification/image.h

@@ -77,7 +77,7 @@ class KNP_DECLSPEC Dataset final : public classification::Dataset
 
     /**
      * @brief Create a incrementing image to spikes converter
-     * @detail Spikes will be sent for active_steps steps, and spikes wont be sent for steps_per_image-active_steps
+     * @details Spikes will be sent for active_steps steps, and spikes wont be sent for steps_per_image-active_steps
      * steps. This converter considered incrementing because it will add state_increment_factor * image_pixel to states,
      * and when value is greater than one, this considered a spike.
      * @param active_steps Amount of active steps, active steps are steps when spikes being sent, must be <

knp/base-framework/include/knp/framework/inference_evaluation/classification.h

@@ -41,36 +41,36 @@ class KNP_DECLSPEC InferenceResultForClass
 public:
     /**
      * @brief Get true positives.
-     * @ret Amount of times model, that is supposed  to predict dog, predicted dog when it is a dog.
+     * @return Amount of times model, that is supposed  to predict dog, predicted dog when it is a dog.
      */
     [[nodiscard]] size_t get_true_positives() const { return true_positives_; }
 
     /**
      * @brief Get false negatives.
-     * @ret Amount of times model, that is supposed to predict dog, predicted not a dog when it is a dog.
+     * @return Amount of times model, that is supposed to predict dog, predicted not a dog when it is a dog.
      */
     [[nodiscard]] size_t get_false_negatives() const { return false_negatives_; }
 
     /**
      * @brief Get false positives.
-     * @ret Amount of times model, that is supposed to predict dog, predicted dog when it is not a dog.
+     * @return Amount of times model, that is supposed to predict dog, predicted dog when it is not a dog.
      */
     [[nodiscard]] size_t get_false_positives() const { return false_positives_; }
 
     /**
      * @brief Get true negatives.
-     * @ret Amount of times model, that is supposed to predict dog, predicted not a dog when it is a not a dog.
+     * @return Amount of times model, that is supposed to predict dog, predicted not a dog when it is a not a dog.
      */
     [[nodiscard]] size_t get_true_negatives() const { return true_negatives_; }
 
     /**
      * @brief Shortcut for getting total votes.
-     * @ret Total votes.
+     * @return Total votes.
      */
     [[nodiscard]] size_t get_total_votes() const { return true_positives_ + false_negatives_ + false_positives_; }
 
     /**
-     * @detail A class to process inference results.
+     * @details A class to process inference results.
      */
     class KNP_DECLSPEC InferenceResultsProcessor
     {
@@ -79,7 +79,7 @@ class KNP_DECLSPEC InferenceResultForClass
          * @brief Process inference results. Suited for classification models.
          * @param spikes All spikes from inference.
          * @param dataset Dataset.
-         * @return processed inference results for each class.
+         * @returnurn processed inference results for each class.
          */
         void process_inference_results(
             const std::vector<knp::core::messaging::SpikeMessage> &spikes,
@@ -93,7 +93,7 @@ class KNP_DECLSPEC InferenceResultForClass
 
         /**
          * @brief Get inference results.
-         * @ret Inference results.
+         * @return Inference results.
          */
         [[nodiscard]] auto const &get_inference_results() const { return inference_results_; }
 

knp/base-framework/include/knp/framework/inference_evaluation/perfomance_metrics.h

@@ -31,6 +31,7 @@ namespace knp::framework::inference_evaluation
  * @brief Calculate precision.
  * @param true_positives Amount of times model, that is supposed to predict dog, predicted dog when it is a dog.
  * @param false_positives Amount of times model, that is supposed to predict dog, predicted dog when it is not a dog.
+ * @ret Precision.
  */
 KNP_DECLSPEC float get_precision(size_t true_positives, size_t false_positives);
 
@@ -50,6 +51,7 @@ KNP_DECLSPEC float get_recall(size_t true_positives, size_t false_negatives);
  * @param false_positives Amount of times model, that is supposed to predict dog, predicted dog when it is not a dog.
  * @param true_negatives Amount of times model, that is supposed to predict dog, predicted not a dog when it is a not a
  * dog.
+ * @ret Prevalence.
  */
 KNP_DECLSPEC float get_prevalence(
     size_t true_positives, size_t false_negatives, size_t false_positives, size_t true_negatives);
@@ -62,6 +64,7 @@ KNP_DECLSPEC float get_prevalence(
  * @param false_positives Amount of times model, that is supposed to predict dog, predicted dog when it is not a dog.
  * @param true_negatives Amount of times model, that is supposed to predict dog, predicted not a dog when it is a not a
  * dog.
+ * @ret Accuracy.
  */
 KNP_DECLSPEC float get_accuracy(
     size_t true_positives, size_t false_negatives, size_t false_positives, size_t true_negatives);
@@ -71,6 +74,7 @@ KNP_DECLSPEC float get_accuracy(
  * @brief Calculate f measure.
  * @param precision Precision.
  * @param recall Recall.
+ * @ret FMeasure.
  */
 KNP_DECLSPEC float get_f_measure(float precision, float recall);