Skip to content

Issue 434: Fixed imprecise crefs in XML Docs #485

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

Merged
merged 1 commit into from
Jul 16, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Microsoft.ML.Core/Environment/HostEnvironmentBase.cs
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ public interface IMessageSource

/// <summary>
/// A <see cref="IHostEnvironment"/> that is also a channel listener can attach
/// listeners for messages, as sent through <see cref="IChannelProvider.StartPipe"/>.
/// listeners for messages, as sent through <see cref="IChannelProvider.StartPipe{TMessage}"/>.
/// </summary>
public interface IMessageDispatcher : IHostEnvironment
{
Expand Down
6 changes: 3 additions & 3 deletions src/Microsoft.ML.Core/Utilities/VBufferUtils.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1147,11 +1147,11 @@ private static void ApplyWithCoreCopy<TSrc, TDst>(ref VBuffer<TSrc> src, ref VBu
/// storing the result in <paramref name="dst"/>, overwriting any of its existing contents.
/// The contents of <paramref name="dst"/> do not affect calculation. If you instead wish
/// to calculate a function that reads and writes <paramref name="dst"/>, see
/// <see cref="ApplyWith"/> and <see cref="ApplyWithEitherDefined"/>. Post-operation,
/// <see cref="ApplyWith{TSrc,TDst}"/> and <see cref="ApplyWithEitherDefined{TSrc,TDst}"/>. Post-operation,
/// <paramref name="dst"/> will be dense iff <paramref name="src"/> is dense.
/// </summary>
/// <seealso cref="ApplyWith"/>
/// <seealso cref="ApplyWithEitherDefined"/>
/// <seealso cref="ApplyWith{TSrc,TDst}"/>
/// <seealso cref="ApplyWithEitherDefined{TSrc,TDst}"/>
public static void ApplyIntoEitherDefined<TSrc, TDst>(ref VBuffer<TSrc> src, ref VBuffer<TDst> dst, Func<int, TSrc, TDst> func)
{
Contracts.CheckValue(func, nameof(func));
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.ML.Data/DataView/Transposer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1405,7 +1405,7 @@ public static void GetSingleSlotValue<T>(this ITransposeDataView view, int col,
}

/// <summary>
/// The <see cref="ISlotCursor.GetGetter"/> is parameterized by a type that becomes the
/// The <see cref="ISlotCursor.GetGetter{TValue}"/> is parameterized by a type that becomes the
/// type parameter for a <see cref="VBuffer{T}"/>, 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ public static void AddMultWithOffset(ref VBuffer<Float> src, Float c, ref VBuffe
/// Perform in-place scaling of a vector into another vector as
/// <c><paramref name="dst"/> = <paramref name="src"/> * <paramref name="c"/></c>.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder why we have this depricated folder. Can you please check if the functions in here have any references?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They certainly do. I have no idea why this was put into deprecated, maybe @Ivanidzo4ka knows.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is also spelled as "Depricated" :(

Copy link
Contributor

@Ivanidzo4ka Ivanidzo4ka Jul 3, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as an responsible adult I would totally push my fault on shoulders of others. It appears to have been this way in the migrated codebase for some years, for no particular reason.


In reply to: 199894576 [](ancestors = 199894576)

Copy link
Contributor

@TomFinley TomFinley Jul 3, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds legit.

/// This is more or less equivalent to performing the same operation with
/// <see cref="VBufferUtils.ApplyInto"/> except perhaps more efficiently,
/// <see cref="VBufferUtils.ApplyInto{TSrc1,TSrc2,TDst}"/> except perhaps more efficiently,
/// with one exception: if <paramref name="c"/> is 0 and <paramref name="src"/>
/// is sparse, <paramref name="dst"/> will have a count of zero, instead of the
/// same count as <paramref name="src"/>.
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.ML.Data/Scorers/BinaryClassifierScorer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ private static ISchemaBoundMapper WrapIfNeeded(IHostEnvironment env, ISchemaBoun
/// <param name="labelNameType">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)</param>
/// <returns>Whether we can call <see cref="MultiClassClassifierScorer.LabelNameBindableMapper.CreateBound"/> with
/// <returns>Whether we can call <see cref="MultiClassClassifierScorer.LabelNameBindableMapper.CreateBound{T}"/> with
/// this mapper and expect it to succeed</returns>
private static bool CanWrap(ISchemaBoundMapper mapper, ColumnType labelNameType)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -452,7 +452,7 @@ private static ISchemaBoundMapper WrapIfNeeded(IHostEnvironment env, ISchemaBoun
/// <param name="labelNameType">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)</param>
/// <returns>Whether we can call <see cref="LabelNameBindableMapper.CreateBound"/> with
/// <returns>Whether we can call <see cref="LabelNameBindableMapper.CreateBound{T}"/> with
/// this mapper and expect it to succeed</returns>
public static bool CanWrap(ISchemaBoundMapper mapper, ColumnType labelNameType)
{
Expand Down
7 changes: 2 additions & 5 deletions test/Microsoft.ML.TestFramework/TestCommandBase.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down