Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Doxygen warnings #2400

Merged
merged 40 commits into from May 16, 2020
Merged
Changes from 1 commit
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
56d3365
Fix the latex ELiSH expression.
zoq May 9, 2020
d3057f9
Use the correct expression.
zoq May 10, 2020
81d1dea
latex errors, unfixed as of yet
birm May 10, 2020
8d2ca2d
section name duplication
birm May 10, 2020
3507262
wrong and ambigious @file
birm May 10, 2020
da53245
fix tex for r2
birm May 10, 2020
989e9c0
tex fix mish
birm May 10, 2020
e21aa1b
Configure doxygen to immediately stop when a warning is encountered.
zoq May 10, 2020
1c5e1c8
namespece fix
birm May 10, 2020
e82643e
Do not use '\begin{equation}' to open another math environment.
zoq May 10, 2020
5037868
another dummyclass
birm May 10, 2020
fa875aa
don't try to document ens namespace
birm May 10, 2020
a5ccd71
changing [] to {} fixed somehow
birm May 10, 2020
2f13255
use namespace
birm May 11, 2020
1d5e9b7
re-add namespace qualifier
birm May 11, 2020
c02c006
try using standard format
birm May 11, 2020
65627ef
realign
birm May 11, 2020
1b6bba5
no idea what tutorial is being referenced
birm May 11, 2020
b5515bf
command and ref cleanup
birm May 11, 2020
1565765
doc fixes
birm May 11, 2020
3986361
fix missing, unused, wrong params
birm May 11, 2020
9eb9b31
backtrace style warn fix
birm May 11, 2020
a2acefb
Re-add "Regularization" to param str
birm May 11, 2020
dca79bb
remaining errs
birm May 11, 2020
0599cd0
No more breaking changes please :)
birm May 11, 2020
7c45bdd
Merge branch 'doxy-warn-err' of https://github.com/birm/mlpack into d…
birm May 11, 2020
c03136e
Realign namespace open braces
birm May 11, 2020
799b7e2
align params for SVDWrapper
birm May 11, 2020
f3ad22b
Merge remote-tracking branch 'zoq/elish-latex-fix' into doxy-warn-err
birm May 12, 2020
8f87dbb
Incorporate easily-incorporated suggestions
birm May 13, 2020
67bc405
suggestions which required testing
birm May 13, 2020
46d94d9
fix cf tutorial refs
birm May 13, 2020
3c65293
Add missing href end quote
birm May 13, 2020
496d121
use fuller path names
birm May 13, 2020
df42a83
Merge branch 'doxy-warn-err' of https://github.com/birm/mlpack into d…
birm May 13, 2020
0679529
ens ref to c
birm May 13, 2020
8bc4d69
re-add hpt refs
birm May 13, 2020
6ff6b88
NO_DOXYGEN more descriptive
birm May 13, 2020
420c63c
Merge remote-tracking branch 'upstream/master' into doxy-warn-err
birm May 15, 2020
a52b52f
use full path for normal dist
birm May 15, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 9 additions & 10 deletions doc/tutorials/ann/ann.txt
Expand Up @@ -79,9 +79,8 @@ have a number of methods in common:

@note
To be able to optimize the network, both classes implement the OptimizerFunction
API; see \ref optimizertutorial "Optimizer API" for more information. In short,
birm marked this conversation as resolved.
Show resolved Hide resolved
the \c FNN and \c RNN class implement two methods: \c Evaluate() and \c
Gradient(). This enables the optimization given some learner and some
API. In short, the \c FNN and \c RNN class implement two methods: \c Evaluate()
and \c Gradient(). This enables the optimization given some learner and some
performance measure.

Similar to the existing layer infrastructure, the \c FFN and \c RNN classes are
Expand Down Expand Up @@ -230,13 +229,13 @@ int main()
arma::mat predictionTemp;
model.Predict(testData, predictionTemp);

/*
birm marked this conversation as resolved.
Show resolved Hide resolved
Since the predictionsTemp is of dimensions (3 x number_of_data_points)
with continuous values, we first need to reduce it to a dimension of
/*
Since the predictionsTemp is of dimensions (3 x number_of_data_points)
with continuous values, we first need to reduce it to a dimension of
(1 x number_of_data_points) with scalar values, to be able to compare with
testLabels.

The first step towards doing this is to create a matrix of zeros with the
The first step towards doing this is to create a matrix of zeros with the
desired dimensions (1 x number_of_data_points).

In predictionsTemp, the 3 dimensions for each data point correspond to the
Expand All @@ -252,8 +251,8 @@ int main()
arma::max(predictionTemp.col(i)) == predictionTemp.col(i), 1)) + 1;
}

/*
Compute the error between predictions and testLabels,
/*
Compute the error between predictions and testLabels,
now that we have the desired predictions.
*/
size_t correct = arma::accu(prediction == testLabels);
Expand All @@ -266,7 +265,7 @@ int main()
@endcode

Now, the matrix prediction holds the classification of each point in the
dataset. Subsequently, we find the classification error by comparing it
dataset. Subsequently, we find the classification error by comparing it
with testLabels.

In the next example, we create simple noisy sine sequences, which are trained
Expand Down