Skip to content

Commit 225a373

Browse files
committed
keeping the acronym in the name, but not in documentation
1 parent 70feaf9 commit 225a373

File tree

4 files changed

+14
-14
lines changed

4 files changed

+14
-14
lines changed
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
namespace Microsoft.ML.Samples.Dynamic
88
{
9-
public static class SingularSpectrumAnalysisDetectChangePoint
9+
public static class SsaDetectChangePoint
1010
{
1111
class ChangePointPrediction
1212
{
@@ -54,7 +54,7 @@ public static void Example()
5454
var outputColumnName = nameof(ChangePointPrediction.Prediction);
5555

5656
// The transformed data.
57-
var transformedData = ml.Transforms.SingularSpectrumAnalysisDetectChangePoint(outputColumnName, inputColumnName, 95, 8, TrainingSize, SeasonalitySize + 1).Fit(dataView).Transform(dataView);
57+
var transformedData = ml.Transforms.SsaDetectChangePoint(outputColumnName, inputColumnName, 95, 8, TrainingSize, SeasonalitySize + 1).Fit(dataView).Transform(dataView);
5858

5959
// Getting the data of the newly created column as an IEnumerable of ChangePointPrediction.
6060
var predictionColumn = ml.Data.CreateEnumerable<ChangePointPrediction>(transformedData, reuseRowObject: false);
@@ -115,7 +115,7 @@ public static void SsaChangePointDetectorPrediction()
115115
var outputColumnName = nameof(ChangePointPrediction.Prediction);
116116

117117
// Train the change point detector.
118-
ITransformer model = ml.Transforms.SingularSpectrumAnalysisDetectChangePoint(outputColumnName, inputColumnName, 95, 8, TrainingSize, SeasonalitySize + 1).Fit(dataView);
118+
ITransformer model = ml.Transforms.SsaDetectChangePoint(outputColumnName, inputColumnName, 95, 8, TrainingSize, SeasonalitySize + 1).Fit(dataView);
119119

120120
// Create a prediction engine from the model for feeding new data.
121121
var engine = model.CreateTimeSeriesPredictionFunction<SsaChangePointData, ChangePointPrediction>(ml);
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
namespace Microsoft.ML.Samples.Dynamic
88
{
9-
public static class SingularSpectrumAnalysisDetectSpike
9+
public static class SsaDetectSpike
1010
{
1111
class SsaSpikeData
1212
{
@@ -55,7 +55,7 @@ public static void SsaSpikeDetectorTransform()
5555
var outputColumnName = nameof(SsaSpikePrediction.Prediction);
5656

5757
// The transformed data.
58-
var transformedData = ml.Transforms.SingularSpectrumAnalysisDetectSpike(outputColumnName, inputColumnName, 95, 8, TrainingSize, SeasonalitySize + 1).Fit(dataView).Transform(dataView);
58+
var transformedData = ml.Transforms.SsaDetectSpike(outputColumnName, inputColumnName, 95, 8, TrainingSize, SeasonalitySize + 1).Fit(dataView).Transform(dataView);
5959

6060
// Getting the data of the newly created column as an IEnumerable of SsaSpikePrediction.
6161
var predictionColumn = ml.Data.CreateEnumerable<SsaSpikePrediction>(transformedData, reuseRowObject: false);
@@ -117,7 +117,7 @@ public static void SsaSpikeDetectorPrediction()
117117
var outputColumnName = nameof(SsaSpikePrediction.Prediction);
118118

119119
// Train the change point detector.
120-
ITransformer model = ml.Transforms.SingularSpectrumAnalysisDetectSpike(outputColumnName, inputColumnName, 95, 8, TrainingSize, SeasonalitySize + 1).Fit(dataView);
120+
ITransformer model = ml.Transforms.SsaDetectSpike(outputColumnName, inputColumnName, 95, 8, TrainingSize, SeasonalitySize + 1).Fit(dataView);
121121

122122
// Create a prediction engine from the model for feeding new data.
123123
var engine = model.CreateTimeSeriesPredictionFunction<SsaSpikeData, SsaSpikePrediction>(ml);

src/Microsoft.ML.TimeSeries.StaticPipe/TimeSeriesStatic.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ public override IEstimator<ITransformer> Reconcile(IHostEnvironment env,
200200
{
201201
Contracts.Assert(toOutput.Length == 1);
202202
var outCol = (OutColumn)toOutput[0];
203-
return new MLContext().Transforms.SingularSpectrumAnalysisDetectChangePoint(
203+
return new MLContext().Transforms.SsaDetectChangePoint(
204204
outputNames[outCol],
205205
inputNames[outCol.Input],
206206
_confidence,
@@ -282,7 +282,7 @@ public override IEstimator<ITransformer> Reconcile(IHostEnvironment env,
282282
{
283283
Contracts.Assert(toOutput.Length == 1);
284284
var outCol = (OutColumn)toOutput[0];
285-
return new MLContext().Transforms.SingularSpectrumAnalysisDetectSpike(
285+
return new MLContext().Transforms.SsaDetectSpike(
286286
outputNames[outCol],
287287
inputNames[outCol.Input],
288288
_confidence,

src/Microsoft.ML.TimeSeries/ExtensionsCatalog.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ public static class TimeSeriesCatalog
2424
/// <example>
2525
/// <format type="text/markdown">
2626
/// <![CDATA[
27-
/// [!code-csharp[DetectIidChangePoint](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/TimeSeries/DetectIndependentIdenticallyDistributedChangePoint.cs)]
27+
/// [!code-csharp[DetectIidChangePoint](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/TimeSeries/DetectIidChangePoint.cs)]
2828
/// ]]>
2929
/// </format>
3030
/// </example>
@@ -45,7 +45,7 @@ public static IidChangePointEstimator DetectIidChangePoint(this TransformsCatalo
4545
/// <example>
4646
/// <format type="text/markdown">
4747
/// <![CDATA[
48-
/// [!code-csharp[DetectIidSpike](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/TimeSeries/DetectIndependentIdenticallyDistributedSpike.cs)]
48+
/// [!code-csharp[DetectIidSpike](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/TimeSeries/DetectIidSpike.cs)]
4949
/// ]]>
5050
/// </format>
5151
/// </example>
@@ -70,11 +70,11 @@ public static IidSpikeEstimator DetectIidSpike(this TransformsCatalog catalog, s
7070
/// <example>
7171
/// <format type="text/markdown">
7272
/// <![CDATA[
73-
/// [!code-csharp[SsaChangePointEstimator](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/TimeSeries/SsaChangePointEstimator.cs)]
73+
/// [!code-csharp[SsaChangePointEstimator](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/TimeSeries/SsaDetectChangePoint.cs)]
7474
/// ]]>
7575
/// </format>
7676
/// </example>
77-
public static SsaChangePointEstimator SingularSpectrumAnalysisDetectChangePoint(this TransformsCatalog catalog, string outputColumnName, string inputColumnName,
77+
public static SsaChangePointEstimator SsaDetectChangePoint(this TransformsCatalog catalog, string outputColumnName, string inputColumnName,
7878
int confidence, int changeHistoryLength, int trainingWindowSize, int seasonalityWindowSize, ErrorFunction errorFunction = ErrorFunction.SignedDifference,
7979
MartingaleType martingale = MartingaleType.Power, double eps = 0.1)
8080
=> new SsaChangePointEstimator(CatalogUtils.GetEnvironment(catalog), new SsaChangePointDetector.Options
@@ -106,11 +106,11 @@ public static SsaChangePointEstimator SingularSpectrumAnalysisDetectChangePoint(
106106
/// <example>
107107
/// <format type="text/markdown">
108108
/// <![CDATA[
109-
/// [!code-csharp[SingularSpectrumAnalysisDetectSpike](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/TimeSeries/SingularSpectrumAnalysisDetectSpike.cs)]
109+
/// [!code-csharp[SingularSpectrumAnalysisDetectSpike](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/TimeSeries/SsaDetectSpike.cs)]
110110
/// ]]>
111111
/// </format>
112112
/// </example>
113-
public static SsaSpikeEstimator SingularSpectrumAnalysisDetectSpike(this TransformsCatalog catalog, string outputColumnName, string inputColumnName, int confidence, int pvalueHistoryLength,
113+
public static SsaSpikeEstimator SsaDetectSpike(this TransformsCatalog catalog, string outputColumnName, string inputColumnName, int confidence, int pvalueHistoryLength,
114114
int trainingWindowSize, int seasonalityWindowSize, AnomalySide side = AnomalySide.TwoSided, ErrorFunction errorFunction = ErrorFunction.SignedDifference)
115115
=> new SsaSpikeEstimator(CatalogUtils.GetEnvironment(catalog), outputColumnName, confidence, pvalueHistoryLength, trainingWindowSize, seasonalityWindowSize, inputColumnName, side, errorFunction);
116116
}

0 commit comments

Comments
 (0)