Skip to content
Snippets Groups Projects
Commit a617e79a authored by Franck Dary's avatar Franck Dary
Browse files

Fixed various misses in the documentation

parent ae0c931c
No related branches found
No related tags found
No related merge requests found
......@@ -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.
......
......@@ -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.
......
......@@ -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.
......
......@@ -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);
};
......
......@@ -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 :
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment