From a617e79a95182d4ffea6d1b0c3e848c3075f08f7 Mon Sep 17 00:00:00 2001
From: Franck Dary <franck.dary@etu.univ-amu.fr>
Date: Tue, 7 Aug 2018 14:37:22 +0200
Subject: [PATCH] Fixed various misses in the documentation
---
MLP/include/MLP.hpp | 1 +
tape_machine/include/ActionBank.hpp | 6 +++---
tape_machine/include/Classifier.hpp | 1 +
tape_machine/include/Oracle.hpp | 7 ++-----
trainer/include/Trainer.hpp | 3 +++
5 files changed, 10 insertions(+), 8 deletions(-)
diff --git a/MLP/include/MLP.hpp b/MLP/include/MLP.hpp
index 82a97c4..b4f102a 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 5a46300..6bc957e 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 32b13a4..f8a598b 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 b604df9..5ac85c5 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 2535e5d..f202b0f 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 :
--
GitLab