Skip to content

Commit 781293d

Browse files
sfilipisfilipi
committed
adding more documentation.
changing the root of the XML documents from docs -> doc, since its only one. Switching all <see href /> to the valid <see cref />
1 parent dc01215 commit 781293d

File tree

60 files changed

+653
-298
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+653
-298
lines changed

‎src/Microsoft.ML.Core/Utilities/ReservoirSampler.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public interface IReservoirSampler<T>
4747
/// This class produces a sample without replacement from a stream of data of type <typeparamref name="T"/>.
4848
/// It is instantiated with a delegate that gets the next data point, and builds a reservoir in one pass by calling <see cref="Sample"/>
4949
/// for every data point in the stream. In case the next data point does not get 'picked' into the reservoir, the delegate is not invoked.
50-
/// Sampling is done according to the algorithm in this paper: <see href="http://epubs.siam.org/doi/pdf/10.1137/1.9781611972740.53"/>.
50+
/// Sampling is done according to the algorithm in this paper: <a href="http://epubs.siam.org/doi/pdf/10.1137/1.9781611972740.53">http://epubs.siam.org/doi/pdf/10.1137/1.9781611972740.53</a>.
5151
/// </summary>
5252
public sealed class ReservoirSamplerWithoutReplacement<T> : IReservoirSampler<T>
5353
{
@@ -120,7 +120,7 @@ public IEnumerable<T> GetSample()
120120
/// This class produces a sample with replacement from a stream of data of type <typeparamref name="T"/>.
121121
/// It is instantiated with a delegate that gets the next data point, and builds a reservoir in one pass by calling <see cref="Sample"/>
122122
/// for every data point in the stream. In case the next data point does not get 'picked' into the reservoir, the delegate is not invoked.
123-
/// Sampling is done according to the algorithm in this paper: <see href="http://epubs.siam.org/doi/pdf/10.1137/1.9781611972740.53"/>.
123+
/// Sampling is done according to the algorithm in this paper: <a href="http://epubs.siam.org/doi/pdf/10.1137/1.9781611972740.53">http://epubs.siam.org/doi/pdf/10.1137/1.9781611972740.53</a>.
124124
/// </summary>
125125
public sealed class ReservoirSamplerWithReplacement<T> : IReservoirSampler<T>
126126
{

‎src/Microsoft.ML.Data/Evaluators/AucAggregator.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,7 @@ public UnweightedAuPrcAggregator(IRandom rand, int reservoirSize)
408408

409409
/// <summary>
410410
/// Compute the AUPRC using the "lower trapesoid" estimator, as described in the paper
411-
/// <see href="http://www.ecmlpkdd2013.org/wp-content/uploads/2013/07/aucpr_2013ecml_corrected.pdf"/>.
411+
/// <a href="http://www.ecmlpkdd2013.org/wp-content/uploads/2013/07/aucpr_2013ecml_corrected.pdf">http://www.ecmlpkdd2013.org/wp-content/uploads/2013/07/aucpr_2013ecml_corrected.pdf</a>.
412412
/// </summary>
413413
protected override Double ComputeWeightedAuPrcCore(out Double unweighted)
414414
{
@@ -482,7 +482,7 @@ public WeightedAuPrcAggregator(IRandom rand, int reservoirSize)
482482

483483
/// <summary>
484484
/// Compute the AUPRC using the "lower trapesoid" estimator, as described in the paper
485-
/// <see href="http://www.ecmlpkdd2013.org/wp-content/uploads/2013/07/aucpr_2013ecml_corrected.pdf"/>.
485+
/// <a href="http://www.ecmlpkdd2013.org/wp-content/uploads/2013/07/aucpr_2013ecml_corrected.pdf">http://www.ecmlpkdd2013.org/wp-content/uploads/2013/07/aucpr_2013ecml_corrected.pdf</a>.
486486
/// </summary>
487487
protected override Double ComputeWeightedAuPrcCore(out Double unweighted)
488488
{

‎src/Microsoft.ML.Data/Transforms/TermTransform.cs‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,14 @@
2929

3030
namespace Microsoft.ML.Runtime.Data
3131
{
32-
/// <summary>
33-
/// TermTransform builds up term vocabularies (dictionaries).
34-
/// Notes:
35-
/// * Each column builds/uses exactly one "vocabulary" (dictionary).
36-
/// * Output columns are KeyType-valued.
37-
/// * The Key value is the one-based index of the item in the dictionary.
38-
/// * Not found is assigned the value zero.
39-
/// </summary>
32+
33+
// TermTransform builds up term vocabularies (dictionaries).
34+
// Notes:
35+
// * Each column builds/uses exactly one "vocabulary" (dictionary).
36+
// * Output columns are KeyType-valued.
37+
// * The Key value is the one-based index of the item in the dictionary.
38+
// * Not found is assigned the value zero.
39+
/// <include file='doc.xml' path='doc/members/member[@name="TextToKey"]/*' />
4040
public sealed partial class TermTransform : OneToOneTransformBase, ITransformTemplate
4141
{
4242
public abstract class ColumnBase : OneToOneColumn

‎src/Microsoft.ML.FastTree/FastTreeArguments.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ public interface IFastTreeTrainerFactory : IComponentFactory<ITrainer>
2020
{
2121
}
2222

23-
/// <include file='./doc.xml' path='docs/members/member[@name="FastTree"]/*' />
23+
/// <include file='doc.xml' path='doc/members/member[@name="FastTree"]/*' />
2424
public sealed partial class FastTreeBinaryClassificationTrainer
2525
{
2626
[TlcModule.Component(Name = LoadNameValue, FriendlyName = UserNameValue, Desc = Summary)]

‎src/Microsoft.ML.FastTree/FastTreeClassification.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ public static IPredictorProducing<Float> Create(IHostEnvironment env, ModelLoadC
100100
public override PredictionKind PredictionKind { get { return PredictionKind.BinaryClassification; } }
101101
}
102102

103-
/// <include file = './doc.xml' path='docs/members/member[@name="FastTree"]/*' />
103+
/// <include file = './doc.xml' path='doc/members/member[@name="FastTree"]/*' />
104104
public sealed partial class FastTreeBinaryClassificationTrainer :
105105
BoostingFastTreeTrainerBase<FastTreeBinaryClassificationTrainer.Arguments, IPredictorWithFeatureWeights<Float>>
106106
{
@@ -346,7 +346,7 @@ public static partial class FastTree
346346
Desc = FastTreeBinaryClassificationTrainer.Summary,
347347
UserName = FastTreeBinaryClassificationTrainer.UserNameValue,
348348
ShortName = FastTreeBinaryClassificationTrainer.ShortName,
349-
XmlInclude = new[] { @"<include file='../Microsoft.ML.FastTree/doc.xml' path='docs/members/member[@name=""FastTree""]/*' />" })]
349+
XmlInclude = new[] { @"<include file='../Microsoft.ML.FastTree/doc.xml' path='doc/members/member[@name=""FastTree""]/*' />" })]
350350
public static CommonOutputs.BinaryClassificationOutput TrainBinary(IHostEnvironment env, FastTreeBinaryClassificationTrainer.Arguments input)
351351
{
352352
Contracts.CheckValue(env, nameof(env));

‎src/Microsoft.ML.FastTree/FastTreeRanking.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838

3939
namespace Microsoft.ML.Runtime.FastTree
4040
{
41-
/// <include file='./doc.xml' path='docs/members/member[@name="FastTree"]/*' />
41+
/// <include file='doc.xml' path='doc/members/member[@name="FastTree"]/*' />
4242
public sealed partial class FastTreeRankingTrainer : BoostingFastTreeTrainerBase<FastTreeRankingTrainer.Arguments, FastTreeRankingPredictor>,
4343
IHasLabelGains
4444
{
@@ -1101,7 +1101,7 @@ public static partial class FastTree
11011101
Desc = FastTreeRankingTrainer.Summary,
11021102
UserName = FastTreeRankingTrainer.UserNameValue,
11031103
ShortName = FastTreeRankingTrainer.ShortName,
1104-
XmlInclude = new[] { @"<include file='../Microsoft.ML.FastTree/doc.xml' path='docs/members/member[@name=""FastTree""]/*' />" })]
1104+
XmlInclude = new[] { @"<include file='../Microsoft.ML.FastTree/doc.xml' path='doc/members/member[@name=""FastTree""]/*' />" })]
11051105
public static CommonOutputs.RankingOutput TrainRanking(IHostEnvironment env, FastTreeRankingTrainer.Arguments input)
11061106
{
11071107
Contracts.CheckValue(env, nameof(env));

‎src/Microsoft.ML.FastTree/FastTreeRegression.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131

3232
namespace Microsoft.ML.Runtime.FastTree
3333
{
34-
/// <include file='./doc.xml' path='docs/members/member[@name="FastTree"]/*' />
34+
/// <include file='doc.xml' path='doc/members/member[@name="FastTree"]/*' />
3535
public sealed partial class FastTreeRegressionTrainer : BoostingFastTreeTrainerBase<FastTreeRegressionTrainer.Arguments, FastTreeRegressionPredictor>
3636
{
3737
public const string LoadNameValue = "FastTreeRegression";
@@ -453,7 +453,7 @@ public static partial class FastTree
453453
Desc = FastTreeRegressionTrainer.Summary,
454454
UserName = FastTreeRegressionTrainer.UserNameValue,
455455
ShortName = FastTreeRegressionTrainer.ShortName,
456-
XmlInclude = new[] { @"<include file='../Microsoft.ML.FastTree/doc.xml' path='docs/members/member[@name=""FastTree""]/*' />" })]
456+
XmlInclude = new[] { @"<include file='../Microsoft.ML.FastTree/doc.xml' path='doc/members/member[@name=""FastTree""]/*' />" })]
457457
public static CommonOutputs.RegressionOutput TrainRegression(IHostEnvironment env, FastTreeRegressionTrainer.Arguments input)
458458
{
459459
Contracts.CheckValue(env, nameof(env));

‎src/Microsoft.ML.FastTree/FastTreeTweedie.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ namespace Microsoft.ML.Runtime.FastTree
3030
// The Tweedie boosting model follows the mathematics established in:
3131
// Yang, Quan, and Zou. "Insurance Premium Prediction via Gradient Tree-Boosted Tweedie Compound Poisson Models."
3232
// https://arxiv.org/pdf/1508.06378.pdf
33-
/// <include file='./doc.xml' path='docs/members/member[@name="FastTreeTweedieRegression"]/*' />
33+
/// <include file='doc.xml' path='doc/members/member[@name="FastTreeTweedieRegression"]/*' />
3434
public sealed partial class FastTreeTweedieTrainer : BoostingFastTreeTrainerBase<FastTreeTweedieTrainer.Arguments, FastTreeTweediePredictor>
3535
{
3636
public const string LoadNameValue = "FastTreeTweedieRegression";
@@ -461,7 +461,7 @@ public static partial class FastTree
461461
Desc = FastTreeTweedieTrainer.Summary,
462462
UserName = FastTreeTweedieTrainer.UserNameValue,
463463
ShortName = FastTreeTweedieTrainer.ShortName,
464-
XmlInclude = new [] { @"<include file='../Microsoft.ML.FastTree/doc.xml' path='docs/members/member[@name=""FastTreeTweedieRegression""]/*' />" })]
464+
XmlInclude = new [] { @"<include file='../Microsoft.ML.FastTree/doc.xml' path='doc/members/member[@name=""FastTreeTweedieRegression""]/*' />" })]
465465
public static CommonOutputs.RegressionOutput TrainTweedieRegression(IHostEnvironment env, FastTreeTweedieTrainer.Arguments input)
466466
{
467467
Contracts.CheckValue(env, nameof(env));

‎src/Microsoft.ML.FastTree/RandomForestClassification.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ public static IPredictorProducing<Float> Create(IHostEnvironment env, ModelLoadC
106106
}
107107
}
108108

109-
/// <include file='./doc.xml' path='docs/members/member[@name="FastForest"]/*' />
109+
/// <include file='doc.xml' path='doc/members/member[@name="FastForest"]/*' />
110110
public sealed partial class FastForestClassification :
111111
RandomForestTrainerBase<FastForestClassification.Arguments, IPredictorWithFeatureWeights<Float>>
112112
{
@@ -213,7 +213,7 @@ public static partial class FastForest
213213
Desc = FastForestClassification.Summary,
214214
UserName = FastForestClassification.UserNameValue,
215215
ShortName = FastForestClassification.ShortName,
216-
XmlInclude = new[] { @"<include file='../Microsoft.ML.FastTree/doc.xml' path='docs/members/member[@name=""FastForest""]/*' />" })]
216+
XmlInclude = new[] { @"<include file='../Microsoft.ML.FastTree/doc.xml' path='doc/members/member[@name=""FastForest""]/*' />" })]
217217
public static CommonOutputs.BinaryClassificationOutput TrainBinary(IHostEnvironment env, FastForestClassification.Arguments input)
218218
{
219219
Contracts.CheckValue(env, nameof(env));

‎src/Microsoft.ML.FastTree/RandomForestRegression.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ public ISchemaBindableMapper CreateMapper(Double[] quantiles)
137137
}
138138
}
139139

140-
/// <include file='./doc.xml' path='docs/members/member[@name="FastForest"]/*' />
140+
/// <include file='doc.xml' path='doc/members/member[@name="FastForest"]/*' />
141141
public sealed partial class FastForestRegression : RandomForestTrainerBase<FastForestRegression.Arguments, FastForestRegressionPredictor>
142142
{
143143
public sealed class Arguments : FastForestArgumentsBase
@@ -285,7 +285,7 @@ public static partial class FastForest
285285
Desc = FastForestRegression.Summary,
286286
UserName = FastForestRegression.LoadNameValue,
287287
ShortName = FastForestRegression.ShortName,
288-
XmlInclude = new[] { @"<include file='../Microsoft.ML.FastTree/doc.xml' path='docs/members/member[@name=""FastForest""]/*' />" })]
288+
XmlInclude = new[] { @"<include file='../Microsoft.ML.FastTree/doc.xml' path='doc/members/member[@name=""FastForest""]/*' />" })]
289289
public static CommonOutputs.RegressionOutput TrainRegression(IHostEnvironment env, FastForestRegression.Arguments input)
290290
{
291291
Contracts.CheckValue(env, nameof(env));

0 commit comments

Comments
 (0)