diff --git a/MLP/include/MLP.hpp b/MLP/include/MLP.hpp index 82a97c49defd2391481d611dbdd995223da760f4..b4f102ae90e6f435d2b68a6b3fe37b88b6aae35f 100644 --- a/MLP/include/MLP.hpp +++ b/MLP/include/MLP.hpp @@ -20,6 +20,7 @@ class MLP { public : + /// @brief A sequence of training examples, accompanied by the order in which it has to be iterated over. using Examples = std::pair< std::vector<int>, std::vector<std::pair<int, FeatureModel::FeatureDescription> > >; /// @brief Activation function for a MLP Layer. diff --git a/tape_machine/include/ActionBank.hpp b/tape_machine/include/ActionBank.hpp index 5a4630002e7e59c2ca1c96ebad1e402c8ae67f1c..6bc957ea68940f862546e5b1d8fa540afd19d940 100644 --- a/tape_machine/include/ActionBank.hpp +++ b/tape_machine/include/ActionBank.hpp @@ -10,8 +10,8 @@ /// @brief Retrieve a sequence of BasicAction from an action name. /// The purpose of this class is to parse an action name and use it to construct -/// the corresponding sequence of BasicAction.\nThe caller will then probably use -/// this sequence of BasicAction to create an Action. +/// the corresponding sequence of BasicAction.\n +/// The caller will then probably use this sequence of BasicAction to create an Action. class ActionBank { public : @@ -46,7 +46,7 @@ class ActionBank const std::string & tapeName, int relativeIndex); /// @brief Apply a transformation rule to a copy of a multi-tapes buffer cell, and write the result in another cell. - /// A rule is in the form '@er@w' which in this case means 'remove er suffix and add w suffix' + /// A rule is in the form '\@er\@w' which in this case means 'remove er suffix and add w suffix' /// @param config The Config which buffer will be written into. /// @param fromTapeName The name of the buffer's tape containing the string to copy and transform. /// @param targetTapeName The name of the buffer's tape the result will be written to. diff --git a/tape_machine/include/Classifier.hpp b/tape_machine/include/Classifier.hpp index 32b13a419ef0d8b0753b6be61981a337b2136570..f8a598bcf456b5cb675f11259047cc6e43a9fc4c 100644 --- a/tape_machine/include/Classifier.hpp +++ b/tape_machine/include/Classifier.hpp @@ -18,6 +18,7 @@ class Classifier { public : + /// @brief A set of Actions with their corresponding weight. using WeightedActions = std::vector< std::pair<float, std::string> >; /// @brief There are 3 types of Classifier. diff --git a/tape_machine/include/Oracle.hpp b/tape_machine/include/Oracle.hpp index b604df98a48e99489798f217d1987134c2b1dc0b..5ac85c55568f51ff2cbc0e5c9417317c577d21af 100644 --- a/tape_machine/include/Oracle.hpp +++ b/tape_machine/include/Oracle.hpp @@ -70,12 +70,9 @@ class Oracle std::string getAction(Config & config); /// @brief Initialize this oracle, by calling initialize. void init(); - /// @brief + /// @brief Set the member filename. /// - /// @param filename - /// @brief Set filename - /// - /// @param filename The member filename. + /// @param filename The name of the file that can be used by the Oracle. void setFilename(const std::string & filename); }; diff --git a/trainer/include/Trainer.hpp b/trainer/include/Trainer.hpp index 2535e5de361a3d995b203851320e5ac9faecb6d3..f202b0f84555cdbd8b3edf5846927b3f87314c70 100644 --- a/trainer/include/Trainer.hpp +++ b/trainer/include/Trainer.hpp @@ -36,8 +36,11 @@ class Trainer public : + /// @brief The FeatureDescritpion of a Config. using FD = FeatureModel::FeatureDescription; + /// @brief A training example, a pair of a class to predict and the FeatureDescription of the corresponding Config. using Example = std::pair<int, FD>; + /// @brief Iterator type of a vector of training examples. using ExamplesIter = std::vector<std::pair<int, FeatureModel::FeatureDescription> >::iterator; private :