From 0c2223a57922b424eaedd93a3b7a2aed4a43f568 Mon Sep 17 00:00:00 2001 From: Markus Weimer Date: Tue, 3 Jul 2018 09:42:18 -0700 Subject: [PATCH] Issue 434: Fixed imprecise `cref`s in XML Docs This fixes a couple of dangling `cref` in the XML Docs. This commit doesn't contain functional changes to the code. Issue: This closes #434 --- src/Microsoft.ML.Core/Environment/HostEnvironmentBase.cs | 2 +- src/Microsoft.ML.Core/Utilities/VBufferUtils.cs | 6 +++--- src/Microsoft.ML.Data/DataView/Transposer.cs | 2 +- .../Depricated/Vector/VBufferMathUtils.cs | 2 +- src/Microsoft.ML.Data/Scorers/BinaryClassifierScorer.cs | 2 +- .../Scorers/MultiClassClassifierScorer.cs | 2 +- test/Microsoft.ML.TestFramework/TestCommandBase.cs | 7 ++----- 7 files changed, 10 insertions(+), 13 deletions(-) diff --git a/src/Microsoft.ML.Core/Environment/HostEnvironmentBase.cs b/src/Microsoft.ML.Core/Environment/HostEnvironmentBase.cs index 631de3eb77..b4d9337695 100644 --- a/src/Microsoft.ML.Core/Environment/HostEnvironmentBase.cs +++ b/src/Microsoft.ML.Core/Environment/HostEnvironmentBase.cs @@ -87,7 +87,7 @@ public interface IMessageSource /// /// A that is also a channel listener can attach - /// listeners for messages, as sent through . + /// listeners for messages, as sent through . /// public interface IMessageDispatcher : IHostEnvironment { diff --git a/src/Microsoft.ML.Core/Utilities/VBufferUtils.cs b/src/Microsoft.ML.Core/Utilities/VBufferUtils.cs index ae2463da0c..12d5bfcccb 100644 --- a/src/Microsoft.ML.Core/Utilities/VBufferUtils.cs +++ b/src/Microsoft.ML.Core/Utilities/VBufferUtils.cs @@ -1147,11 +1147,11 @@ private static void ApplyWithCoreCopy(ref VBuffer src, ref VBu /// storing the result in , overwriting any of its existing contents. /// The contents of do not affect calculation. If you instead wish /// to calculate a function that reads and writes , see - /// and . Post-operation, + /// and . Post-operation, /// will be dense iff is dense. /// - /// - /// + /// + /// public static void ApplyIntoEitherDefined(ref VBuffer src, ref VBuffer dst, Func func) { Contracts.CheckValue(func, nameof(func)); diff --git a/src/Microsoft.ML.Data/DataView/Transposer.cs b/src/Microsoft.ML.Data/DataView/Transposer.cs index 3baf8a7379..74477de9b7 100644 --- a/src/Microsoft.ML.Data/DataView/Transposer.cs +++ b/src/Microsoft.ML.Data/DataView/Transposer.cs @@ -1405,7 +1405,7 @@ public static void GetSingleSlotValue(this ITransposeDataView view, int col, } /// - /// The is parameterized by a type that becomes the + /// The is parameterized by a type that becomes the /// type parameter for a , and this is generally preferable and more /// sensible but for various reasons it's often a lot simpler to have a get-getter be over /// the actual type returned by the getter, that is, parameterize this by the actual diff --git a/src/Microsoft.ML.Data/Depricated/Vector/VBufferMathUtils.cs b/src/Microsoft.ML.Data/Depricated/Vector/VBufferMathUtils.cs index 0199c30915..045c5d30a1 100644 --- a/src/Microsoft.ML.Data/Depricated/Vector/VBufferMathUtils.cs +++ b/src/Microsoft.ML.Data/Depricated/Vector/VBufferMathUtils.cs @@ -350,7 +350,7 @@ public static void AddMultWithOffset(ref VBuffer src, Float c, ref VBuffe /// Perform in-place scaling of a vector into another vector as /// = * . /// This is more or less equivalent to performing the same operation with - /// except perhaps more efficiently, + /// except perhaps more efficiently, /// with one exception: if is 0 and /// is sparse, will have a count of zero, instead of the /// same count as . diff --git a/src/Microsoft.ML.Data/Scorers/BinaryClassifierScorer.cs b/src/Microsoft.ML.Data/Scorers/BinaryClassifierScorer.cs index 91f799b2e7..598db3ab46 100644 --- a/src/Microsoft.ML.Data/Scorers/BinaryClassifierScorer.cs +++ b/src/Microsoft.ML.Data/Scorers/BinaryClassifierScorer.cs @@ -82,7 +82,7 @@ private static ISchemaBoundMapper WrapIfNeeded(IHostEnvironment env, ISchemaBoun /// The type of the label names from the metadata (either /// originating from the key value metadata of the training label column, or deserialized /// from the model of a bindable mapper) - /// Whether we can call with + /// Whether we can call with /// this mapper and expect it to succeed private static bool CanWrap(ISchemaBoundMapper mapper, ColumnType labelNameType) { diff --git a/src/Microsoft.ML.Data/Scorers/MultiClassClassifierScorer.cs b/src/Microsoft.ML.Data/Scorers/MultiClassClassifierScorer.cs index 4832f92cd4..c12fd9b4d1 100644 --- a/src/Microsoft.ML.Data/Scorers/MultiClassClassifierScorer.cs +++ b/src/Microsoft.ML.Data/Scorers/MultiClassClassifierScorer.cs @@ -452,7 +452,7 @@ private static ISchemaBoundMapper WrapIfNeeded(IHostEnvironment env, ISchemaBoun /// The type of the label names from the metadata (either /// originating from the key value metadata of the training label column, or deserialized /// from the model of a bindable mapper) - /// Whether we can call with + /// Whether we can call with /// this mapper and expect it to succeed public static bool CanWrap(ISchemaBoundMapper mapper, ColumnType labelNameType) { diff --git a/test/Microsoft.ML.TestFramework/TestCommandBase.cs b/test/Microsoft.ML.TestFramework/TestCommandBase.cs index 4039a22476..18b4abf0cf 100644 --- a/test/Microsoft.ML.TestFramework/TestCommandBase.cs +++ b/test/Microsoft.ML.TestFramework/TestCommandBase.cs @@ -6,16 +6,13 @@ using System.Collections.Generic; using System.IO; using System.Linq; -using Microsoft.ML.Runtime; +using System.Threading; +using System.Threading.Tasks; using Microsoft.ML.Runtime.Command; using Microsoft.ML.Runtime.Data; -using Microsoft.ML.Runtime.EntryPoints; using Microsoft.ML.Runtime.Internal.Utilities; -//using Microsoft.ML.Runtime.StandardLearners; using Microsoft.ML.Runtime.Model; using Microsoft.ML.Runtime.Tools; -using System.Threading; -using System.Threading.Tasks; using Xunit; using Xunit.Abstractions;