Skip to content

Commit 1fb5025

Browse files
committed
Added back documentation for main.cpp in mnist learn example: KasperskyLab#192
1 parent 7736500 commit 1fb5025

1 file changed

Lines changed: 22 additions & 8 deletions

File tree

examples/mnist-learn/main.cpp

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,17 @@
3030
#include "training.h"
3131

3232

33-
// Execute complete model pipeline for specified neuron type.
34-
// This template function orchestrates the entire machine learning pipeline for neural networks, including dataset
35-
// processing, network construction, training, inference, and evaluation. It serves as the core execution engine
36-
// for both AltAI and BLIFAT neuron models.
33+
/**
34+
* @brief Execute complete model pipeline for specified neuron type.
35+
*
36+
* @details This template function orchestrates the entire machine learning pipeline for neural networks, including
37+
* dataset processing, network construction, training, inference, and evaluation. It serves as the core execution
38+
* engine for both AltAI and BLIFAT neuron models.
39+
*
40+
* @tparam Neuron neuron type for neuron model specification.
41+
*
42+
* @param model_desc model description containing configuration parameters and paths.
43+
*/
3744
template <typename Neuron>
3845
void run_model(const ModelDescription& model_desc)
3946
{
@@ -61,10 +68,17 @@ void run_model(const ModelDescription& model_desc)
6168
}
6269

6370

64-
// Main application entry point.
65-
// This function serves as the primary execution point for the MNIST neural network learning application.
66-
// It handles command-line argument parsing, configuration validation, user interaction, and routes execution to
67-
// the appropriate neuron model.
71+
/**
72+
* @brief Main application entry point.
73+
*
74+
* @details This function serves as the primary execution point for the MNIST neural network learning application.
75+
* It handles command-line argument parsing, configuration validation, user interaction, and routes execution to
76+
* the appropriate neuron model.
77+
*
78+
* @param argc argument count.
79+
* @param argv arguments values.
80+
* @return ret code.
81+
*/
6882
int main(int argc, char** argv)
6983
{
7084
// Parse command-line arguments and validate configuration.

0 commit comments

Comments
 (0)