Closed
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
101 changes: 101 additions & 0 deletions src/Microsoft.ML.LightGBM/LightGbmArguments.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,21 +11,40 @@
using Microsoft.ML.Runtime.Internal.Internallearn;
using Microsoft.ML.Runtime.LightGBM;

[assembly: LoadableClass(typeof(LightGbmArguments.CpuExecutionDevice), typeof(LightGbmArguments.CpuExecutionDevice.Arguments),
typeof(SignatureLightGBMExecutionDevice), LightGbmArguments.CpuExecutionDevice.FriendlyName, LightGbmArguments.CpuExecutionDevice.Name)]
[assembly: LoadableClass(typeof(LightGbmArguments.GpuExecutionDevice), typeof(LightGbmArguments.GpuExecutionDevice.Arguments),
typeof(SignatureLightGBMExecutionDevice), LightGbmArguments.GpuExecutionDevice.FriendlyName, LightGbmArguments.GpuExecutionDevice.Name)]

[assembly: LoadableClass(typeof(LightGbmArguments.TreeBooster), typeof(LightGbmArguments.TreeBooster.Arguments),
typeof(SignatureLightGBMBooster), LightGbmArguments.TreeBooster.FriendlyName, LightGbmArguments.TreeBooster.Name)]
[assembly: LoadableClass(typeof(LightGbmArguments.DartBooster), typeof(LightGbmArguments.DartBooster.Arguments),
typeof(SignatureLightGBMBooster), LightGbmArguments.DartBooster.FriendlyName, LightGbmArguments.DartBooster.Name)]
[assembly: LoadableClass(typeof(LightGbmArguments.GossBooster), typeof(LightGbmArguments.GossBooster.Arguments),
typeof(SignatureLightGBMBooster), LightGbmArguments.GossBooster.FriendlyName, LightGbmArguments.GossBooster.Name)]

[assembly: EntryPointModule(typeof(LightGbmArguments.CpuExecutionDevice.Arguments))]
[assembly: EntryPointModule(typeof(LightGbmArguments.GpuExecutionDevice.Arguments))]

[assembly: EntryPointModule(typeof(LightGbmArguments.TreeBooster.Arguments))]
[assembly: EntryPointModule(typeof(LightGbmArguments.DartBooster.Arguments))]
[assembly: EntryPointModule(typeof(LightGbmArguments.GossBooster.Arguments))]

namespace Microsoft.ML.Runtime.LightGBM
{
public delegate void SignatureLightGBMExecutionDevice();

public delegate void SignatureLightGBMBooster();

[TlcModule.ComponentKind("LightGbmExecutionDevice")]
public interface ISupportExecutionDeviceParameterFactory : IComponentFactory<IExecutionDeviceParameter>
{
}
public interface IExecutionDeviceParameter
{
void UpdateParameters(Dictionary<string, object> res);
}

[TlcModule.ComponentKind("BoosterParameterFunction")]
public interface ISupportBoosterParameterFactory : IComponentFactory<IBoosterParameter>
{
Expand DownExpand Up@@ -62,6 +81,22 @@ public virtual void UpdateParameters(Dictionary<string, object> res)
}
}

public abstract class ExecutionDeviceParameter<TArgs> : IExecutionDeviceParameter
where TArgs : class, new()
{
protected TArgs Args { get; }

protected ExecutionDeviceParameter(TArgs args)
{
Args = args;
}

/// <summary>
/// Update the parameters by specific ExecutionDevice, will update parameters into "res" directly.
/// </summary>
public abstract void UpdateParameters(Dictionary<string, object> res);
}

private static string GetArgName(string name)
{
StringBuilder strBuf = new StringBuilder();
Expand All@@ -82,6 +117,65 @@ private static string GetArgName(string name)
return strBuf.ToString();
}


public sealed class CpuExecutionDevice : ExecutionDeviceParameter<CpuExecutionDevice.Arguments>
{
public const string Name = "cpu_device";
public const string FriendlyName = "CPU Device";

[TlcModule.Component(Name = Name, FriendlyName = FriendlyName, Desc = "LightGBM CPU device.")]
public class Arguments : ISupportExecutionDeviceParameterFactory
{
public virtual IExecutionDeviceParameter CreateComponent(IHostEnvironment env) => new CpuExecutionDevice(this);
}

public CpuExecutionDevice(Arguments args)
: base(args)
{
}

public override void UpdateParameters(Dictionary<string, object> res)
{
return;
}
}

public sealed class GpuExecutionDevice : ExecutionDeviceParameter<GpuExecutionDevice.Arguments>
{
public const string Name = "gpu_device";
public const string FriendlyName = "GPU Device";

[TlcModule.Component(Name = Name, FriendlyName = FriendlyName, Desc = "LightGBM GPU device.")]
public class Arguments : ISupportExecutionDeviceParameterFactory
{
[Argument(ArgumentType.AtMostOnce, HelpText = "OpenCL platform ID. Usually each GPU vendor exposes one OpenCL platform. -1 means the system-wide default platform.", ShortName = "gpu_platform_id")]
public int PlatformId = -1;

[Argument(ArgumentType.AtMostOnce, HelpText = "OpenCL device ID in the specified platform. Each GPU in the selected platform has a unique device ID. -1 means the default device in the selected platform.", ShortName = "gpu_device_id")]
public int DeviceId = -1;

[Argument(ArgumentType.AtMostOnce, HelpText = "Use double precision math on GPU?", ShortName = "gpu_use_dp")]
public bool UseDoublePrecision = false;

public virtual IExecutionDeviceParameter CreateComponent(IHostEnvironment env) => new GpuExecutionDevice(this);
}

public GpuExecutionDevice(Arguments args)
: base(args)
{
Contracts.CheckUserArg(Args.PlatformId >= -1, nameof(Args.PlatformId), "must be >= -1.");
Contracts.CheckUserArg(Args.DeviceId >= -1, nameof(Args.DeviceId), "must be >= -1.");
}

public override void UpdateParameters(Dictionary<string, object> res)
{
res["device"] = "gpu";
if (Args.PlatformId != -1) res["gpu_platform_id"] = Args.PlatformId.ToString();
if (Args.DeviceId != -1) res["gpu_device_id"] = Args.DeviceId.ToString();
if (Args.UseDoublePrecision) res["gpu_use_dp"] = Args.UseDoublePrecision.ToString();
}
}

public sealed class TreeBooster : BoosterParameter<TreeBooster.Arguments>
{
public const string Name = "gbdt";
Expand DownExpand Up@@ -355,6 +449,9 @@ public enum EvalMetricType
[Argument(ArgumentType.Multiple, HelpText = "Parallel LightGBM Learning Algorithm", ShortName = "parag")]
public ISupportParallel ParallelTrainer = new SingleTrainerFactory();

[Argument(ArgumentType.Multiple, HelpText = "Which execution device to use, can be cpu_device or gpu_device. Note: GPU device requires compatible build of LightGBM dll.", SortOrder = 3, ShortName = "device")]
public ISupportExecutionDeviceParameterFactory ExecutionDevice = new CpuExecutionDevice.Arguments();

internal Dictionary<string, object> ToDictionary(IHost host)
{
Contracts.CheckValue(host, nameof(host));
Expand DownExpand Up@@ -408,6 +505,10 @@ internal Dictionary<string, object> ToDictionary(IHost host)
res[GetArgName(nameof(MaxCatThreshold))] = MaxCatThreshold.ToString();
res[GetArgName(nameof(CatSmooth))] = CatSmooth.ToString();
res[GetArgName(nameof(CatL2))] = CatL2.ToString();

var executionDeviceParams = ExecutionDevice.CreateComponent(host);
executionDeviceParams.UpdateParameters(res);

return res;
}
}
Expand Down
68 changes: 67 additions & 1 deletion src/Microsoft.ML/CSharpApi.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -7599,6 +7599,14 @@ public sealed partial class LightGbmBinaryClassifier : Microsoft.ML.Runtime.Entr
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

might be worth moving this comment on the actual LightGBMArguments file, since this file is generated. Mabye on the ExecutionDevice classes.

[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -7806,6 +7814,14 @@ public sealed partial class LightGbmClassifier : Microsoft.ML.Runtime.EntryPoint
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -8013,6 +8029,14 @@ public sealed partial class LightGbmRanker : Microsoft.ML.Runtime.EntryPoints.Co
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -8220,6 +8244,14 @@ public sealed partial class LightGbmRegressor : Microsoft.ML.Runtime.EntryPoints
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -15985,8 +16017,42 @@ public sealed class AutoMlStateAutoMlStateBase : AutoMlStateBase
internal override string ComponentName => "AutoMlState";
}

public abstract class BoosterParameterFunction : ComponentKind {}
public abstract class LightGbmExecutionDevice : ComponentKind {}

/// <summary>
/// LightGBM CPU execution device
/// </summary>
public sealed class LightGbmCpuExecutionDevice : LightGbmExecutionDevice
{
internal override string ComponentName => "cpu_device";
}

/// <summary>
/// LightGBM GPU execution device.
/// NOTE: Requires build of LightGBM that supports GPU as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
public sealed class LightGbmGpuExecutionDevice : LightGbmExecutionDevice
{
/// <summary>
/// OpenCL platform ID. Usually each GPU vendor exposes one OpenCL platform. -1 means the system-wide default platform.
/// </summary>
public int PlatformId { get; set; } = -1;

/// <summary>
/// OpenCL device ID in the specified platform. Each GPU in the selected platform has a unique device ID. -1 means the default device in the selected platform.
/// </summary>
public int DeviceId { get; set; } = -1;

/// <summary>
/// Use double precision math on GPU?
/// </summary>
public bool UseDoublePrecision { get; set; } = false;

internal override string ComponentName => "gpu_device";
}

public abstract class BoosterParameterFunction : ComponentKind {}


/// <summary>
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Closed
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
101 changes: 101 additions & 0 deletions src/Microsoft.ML.LightGBM/LightGbmArguments.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,21 +11,40 @@
using Microsoft.ML.Runtime.Internal.Internallearn;
using Microsoft.ML.Runtime.LightGBM;

[assembly: LoadableClass(typeof(LightGbmArguments.CpuExecutionDevice), typeof(LightGbmArguments.CpuExecutionDevice.Arguments),
typeof(SignatureLightGBMExecutionDevice), LightGbmArguments.CpuExecutionDevice.FriendlyName, LightGbmArguments.CpuExecutionDevice.Name)]
[assembly: LoadableClass(typeof(LightGbmArguments.GpuExecutionDevice), typeof(LightGbmArguments.GpuExecutionDevice.Arguments),
typeof(SignatureLightGBMExecutionDevice), LightGbmArguments.GpuExecutionDevice.FriendlyName, LightGbmArguments.GpuExecutionDevice.Name)]

[assembly: LoadableClass(typeof(LightGbmArguments.TreeBooster), typeof(LightGbmArguments.TreeBooster.Arguments),
typeof(SignatureLightGBMBooster), LightGbmArguments.TreeBooster.FriendlyName, LightGbmArguments.TreeBooster.Name)]
[assembly: LoadableClass(typeof(LightGbmArguments.DartBooster), typeof(LightGbmArguments.DartBooster.Arguments),
typeof(SignatureLightGBMBooster), LightGbmArguments.DartBooster.FriendlyName, LightGbmArguments.DartBooster.Name)]
[assembly: LoadableClass(typeof(LightGbmArguments.GossBooster), typeof(LightGbmArguments.GossBooster.Arguments),
typeof(SignatureLightGBMBooster), LightGbmArguments.GossBooster.FriendlyName, LightGbmArguments.GossBooster.Name)]

[assembly: EntryPointModule(typeof(LightGbmArguments.CpuExecutionDevice.Arguments))]
[assembly: EntryPointModule(typeof(LightGbmArguments.GpuExecutionDevice.Arguments))]

[assembly: EntryPointModule(typeof(LightGbmArguments.TreeBooster.Arguments))]
[assembly: EntryPointModule(typeof(LightGbmArguments.DartBooster.Arguments))]
[assembly: EntryPointModule(typeof(LightGbmArguments.GossBooster.Arguments))]

namespace Microsoft.ML.Runtime.LightGBM
{
public delegate void SignatureLightGBMExecutionDevice();

public delegate void SignatureLightGBMBooster();

[TlcModule.ComponentKind("LightGbmExecutionDevice")]
public interface ISupportExecutionDeviceParameterFactory : IComponentFactory<IExecutionDeviceParameter>
{
}
public interface IExecutionDeviceParameter
{
void UpdateParameters(Dictionary<string, object> res);
}

[TlcModule.ComponentKind("BoosterParameterFunction")]
public interface ISupportBoosterParameterFactory : IComponentFactory<IBoosterParameter>
{
Expand DownExpand Up@@ -62,6 +81,22 @@ public virtual void UpdateParameters(Dictionary<string, object> res)
}
}

public abstract class ExecutionDeviceParameter<TArgs> : IExecutionDeviceParameter
where TArgs : class, new()
{
protected TArgs Args { get; }

protected ExecutionDeviceParameter(TArgs args)
{
Args = args;
}

/// <summary>
/// Update the parameters by specific ExecutionDevice, will update parameters into "res" directly.
/// </summary>
public abstract void UpdateParameters(Dictionary<string, object> res);
}

private static string GetArgName(string name)
{
StringBuilder strBuf = new StringBuilder();
Expand All@@ -82,6 +117,65 @@ private static string GetArgName(string name)
return strBuf.ToString();
}


public sealed class CpuExecutionDevice : ExecutionDeviceParameter<CpuExecutionDevice.Arguments>
{
public const string Name = "cpu_device";
public const string FriendlyName = "CPU Device";

[TlcModule.Component(Name = Name, FriendlyName = FriendlyName, Desc = "LightGBM CPU device.")]
public class Arguments : ISupportExecutionDeviceParameterFactory
{
public virtual IExecutionDeviceParameter CreateComponent(IHostEnvironment env) => new CpuExecutionDevice(this);
}

public CpuExecutionDevice(Arguments args)
: base(args)
{
}

public override void UpdateParameters(Dictionary<string, object> res)
{
return;
}
}

public sealed class GpuExecutionDevice : ExecutionDeviceParameter<GpuExecutionDevice.Arguments>
{
public const string Name = "gpu_device";
public const string FriendlyName = "GPU Device";

[TlcModule.Component(Name = Name, FriendlyName = FriendlyName, Desc = "LightGBM GPU device.")]
public class Arguments : ISupportExecutionDeviceParameterFactory
{
[Argument(ArgumentType.AtMostOnce, HelpText = "OpenCL platform ID. Usually each GPU vendor exposes one OpenCL platform. -1 means the system-wide default platform.", ShortName = "gpu_platform_id")]
public int PlatformId = -1;

[Argument(ArgumentType.AtMostOnce, HelpText = "OpenCL device ID in the specified platform. Each GPU in the selected platform has a unique device ID. -1 means the default device in the selected platform.", ShortName = "gpu_device_id")]
public int DeviceId = -1;

[Argument(ArgumentType.AtMostOnce, HelpText = "Use double precision math on GPU?", ShortName = "gpu_use_dp")]
public bool UseDoublePrecision = false;

public virtual IExecutionDeviceParameter CreateComponent(IHostEnvironment env) => new GpuExecutionDevice(this);
}

public GpuExecutionDevice(Arguments args)
: base(args)
{
Contracts.CheckUserArg(Args.PlatformId >= -1, nameof(Args.PlatformId), "must be >= -1.");
Contracts.CheckUserArg(Args.DeviceId >= -1, nameof(Args.DeviceId), "must be >= -1.");
}

public override void UpdateParameters(Dictionary<string, object> res)
{
res["device"] = "gpu";
if (Args.PlatformId != -1) res["gpu_platform_id"] = Args.PlatformId.ToString();
if (Args.DeviceId != -1) res["gpu_device_id"] = Args.DeviceId.ToString();
if (Args.UseDoublePrecision) res["gpu_use_dp"] = Args.UseDoublePrecision.ToString();
}
}

public sealed class TreeBooster : BoosterParameter<TreeBooster.Arguments>
{
public const string Name = "gbdt";
Expand DownExpand Up@@ -355,6 +449,9 @@ public enum EvalMetricType
[Argument(ArgumentType.Multiple, HelpText = "Parallel LightGBM Learning Algorithm", ShortName = "parag")]
public ISupportParallel ParallelTrainer = new SingleTrainerFactory();

[Argument(ArgumentType.Multiple, HelpText = "Which execution device to use, can be cpu_device or gpu_device. Note: GPU device requires compatible build of LightGBM dll.", SortOrder = 3, ShortName = "device")]
public ISupportExecutionDeviceParameterFactory ExecutionDevice = new CpuExecutionDevice.Arguments();

internal Dictionary<string, object> ToDictionary(IHost host)
{
Contracts.CheckValue(host, nameof(host));
Expand DownExpand Up@@ -408,6 +505,10 @@ internal Dictionary<string, object> ToDictionary(IHost host)
res[GetArgName(nameof(MaxCatThreshold))] = MaxCatThreshold.ToString();
res[GetArgName(nameof(CatSmooth))] = CatSmooth.ToString();
res[GetArgName(nameof(CatL2))] = CatL2.ToString();

var executionDeviceParams = ExecutionDevice.CreateComponent(host);
executionDeviceParams.UpdateParameters(res);

return res;
}
}
Expand Down
68 changes: 67 additions & 1 deletion src/Microsoft.ML/CSharpApi.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -7599,6 +7599,14 @@ public sealed partial class LightGbmBinaryClassifier : Microsoft.ML.Runtime.Entr
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

might be worth moving this comment on the actual LightGBMArguments file, since this file is generated. Mabye on the ExecutionDevice classes.

[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -7806,6 +7814,14 @@ public sealed partial class LightGbmClassifier : Microsoft.ML.Runtime.EntryPoint
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -8013,6 +8029,14 @@ public sealed partial class LightGbmRanker : Microsoft.ML.Runtime.EntryPoints.Co
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -8220,6 +8244,14 @@ public sealed partial class LightGbmRegressor : Microsoft.ML.Runtime.EntryPoints
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -15985,8 +16017,42 @@ public sealed class AutoMlStateAutoMlStateBase : AutoMlStateBase
internal override string ComponentName => "AutoMlState";
}

public abstract class BoosterParameterFunction : ComponentKind {}
public abstract class LightGbmExecutionDevice : ComponentKind {}

/// <summary>
/// LightGBM CPU execution device
/// </summary>
public sealed class LightGbmCpuExecutionDevice : LightGbmExecutionDevice
{
internal override string ComponentName => "cpu_device";
}

/// <summary>
/// LightGBM GPU execution device.
/// NOTE: Requires build of LightGBM that supports GPU as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
public sealed class LightGbmGpuExecutionDevice : LightGbmExecutionDevice
{
/// <summary>
/// OpenCL platform ID. Usually each GPU vendor exposes one OpenCL platform. -1 means the system-wide default platform.
/// </summary>
public int PlatformId { get; set; } = -1;

/// <summary>
/// OpenCL device ID in the specified platform. Each GPU in the selected platform has a unique device ID. -1 means the default device in the selected platform.
/// </summary>
public int DeviceId { get; set; } = -1;

/// <summary>
/// Use double precision math on GPU?
/// </summary>
public bool UseDoublePrecision { get; set; } = false;

internal override string ComponentName => "gpu_device";
}

public abstract class BoosterParameterFunction : ComponentKind {}


/// <summary>
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
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
101 changes: 101 additions & 0 deletions src/Microsoft.ML.LightGBM/LightGbmArguments.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,21 +11,40 @@
using Microsoft.ML.Runtime.Internal.Internallearn;
using Microsoft.ML.Runtime.LightGBM;

[assembly: LoadableClass(typeof(LightGbmArguments.CpuExecutionDevice), typeof(LightGbmArguments.CpuExecutionDevice.Arguments),
typeof(SignatureLightGBMExecutionDevice), LightGbmArguments.CpuExecutionDevice.FriendlyName, LightGbmArguments.CpuExecutionDevice.Name)]
[assembly: LoadableClass(typeof(LightGbmArguments.GpuExecutionDevice), typeof(LightGbmArguments.GpuExecutionDevice.Arguments),
typeof(SignatureLightGBMExecutionDevice), LightGbmArguments.GpuExecutionDevice.FriendlyName, LightGbmArguments.GpuExecutionDevice.Name)]

[assembly: LoadableClass(typeof(LightGbmArguments.TreeBooster), typeof(LightGbmArguments.TreeBooster.Arguments),
typeof(SignatureLightGBMBooster), LightGbmArguments.TreeBooster.FriendlyName, LightGbmArguments.TreeBooster.Name)]
[assembly: LoadableClass(typeof(LightGbmArguments.DartBooster), typeof(LightGbmArguments.DartBooster.Arguments),
typeof(SignatureLightGBMBooster), LightGbmArguments.DartBooster.FriendlyName, LightGbmArguments.DartBooster.Name)]
[assembly: LoadableClass(typeof(LightGbmArguments.GossBooster), typeof(LightGbmArguments.GossBooster.Arguments),
typeof(SignatureLightGBMBooster), LightGbmArguments.GossBooster.FriendlyName, LightGbmArguments.GossBooster.Name)]

[assembly: EntryPointModule(typeof(LightGbmArguments.CpuExecutionDevice.Arguments))]
[assembly: EntryPointModule(typeof(LightGbmArguments.GpuExecutionDevice.Arguments))]

[assembly: EntryPointModule(typeof(LightGbmArguments.TreeBooster.Arguments))]
[assembly: EntryPointModule(typeof(LightGbmArguments.DartBooster.Arguments))]
[assembly: EntryPointModule(typeof(LightGbmArguments.GossBooster.Arguments))]

namespace Microsoft.ML.Runtime.LightGBM
{
public delegate void SignatureLightGBMExecutionDevice();

public delegate void SignatureLightGBMBooster();

[TlcModule.ComponentKind("LightGbmExecutionDevice")]
public interface ISupportExecutionDeviceParameterFactory : IComponentFactory<IExecutionDeviceParameter>
{
}
public interface IExecutionDeviceParameter
{
void UpdateParameters(Dictionary<string, object> res);
}

[TlcModule.ComponentKind("BoosterParameterFunction")]
public interface ISupportBoosterParameterFactory : IComponentFactory<IBoosterParameter>
{
Expand DownExpand Up@@ -62,6 +81,22 @@ public virtual void UpdateParameters(Dictionary<string, object> res)
}
}

public abstract class ExecutionDeviceParameter<TArgs> : IExecutionDeviceParameter
where TArgs : class, new()
{
protected TArgs Args { get; }

protected ExecutionDeviceParameter(TArgs args)
{
Args = args;
}

/// <summary>
/// Update the parameters by specific ExecutionDevice, will update parameters into "res" directly.
/// </summary>
public abstract void UpdateParameters(Dictionary<string, object> res);
}

private static string GetArgName(string name)
{
StringBuilder strBuf = new StringBuilder();
Expand All@@ -82,6 +117,65 @@ private static string GetArgName(string name)
return strBuf.ToString();
}


public sealed class CpuExecutionDevice : ExecutionDeviceParameter<CpuExecutionDevice.Arguments>
{
public const string Name = "cpu_device";
public const string FriendlyName = "CPU Device";

[TlcModule.Component(Name = Name, FriendlyName = FriendlyName, Desc = "LightGBM CPU device.")]
public class Arguments : ISupportExecutionDeviceParameterFactory
{
public virtual IExecutionDeviceParameter CreateComponent(IHostEnvironment env) => new CpuExecutionDevice(this);
}

public CpuExecutionDevice(Arguments args)
: base(args)
{
}

public override void UpdateParameters(Dictionary<string, object> res)
{
return;
}
}

public sealed class GpuExecutionDevice : ExecutionDeviceParameter<GpuExecutionDevice.Arguments>
{
public const string Name = "gpu_device";
public const string FriendlyName = "GPU Device";

[TlcModule.Component(Name = Name, FriendlyName = FriendlyName, Desc = "LightGBM GPU device.")]
public class Arguments : ISupportExecutionDeviceParameterFactory
{
[Argument(ArgumentType.AtMostOnce, HelpText = "OpenCL platform ID. Usually each GPU vendor exposes one OpenCL platform. -1 means the system-wide default platform.", ShortName = "gpu_platform_id")]
public int PlatformId = -1;

[Argument(ArgumentType.AtMostOnce, HelpText = "OpenCL device ID in the specified platform. Each GPU in the selected platform has a unique device ID. -1 means the default device in the selected platform.", ShortName = "gpu_device_id")]
public int DeviceId = -1;

[Argument(ArgumentType.AtMostOnce, HelpText = "Use double precision math on GPU?", ShortName = "gpu_use_dp")]
public bool UseDoublePrecision = false;

public virtual IExecutionDeviceParameter CreateComponent(IHostEnvironment env) => new GpuExecutionDevice(this);
}

public GpuExecutionDevice(Arguments args)
: base(args)
{
Contracts.CheckUserArg(Args.PlatformId >= -1, nameof(Args.PlatformId), "must be >= -1.");
Contracts.CheckUserArg(Args.DeviceId >= -1, nameof(Args.DeviceId), "must be >= -1.");
}

public override void UpdateParameters(Dictionary<string, object> res)
{
res["device"] = "gpu";
if (Args.PlatformId != -1) res["gpu_platform_id"] = Args.PlatformId.ToString();
if (Args.DeviceId != -1) res["gpu_device_id"] = Args.DeviceId.ToString();
if (Args.UseDoublePrecision) res["gpu_use_dp"] = Args.UseDoublePrecision.ToString();
}
}

public sealed class TreeBooster : BoosterParameter<TreeBooster.Arguments>
{
public const string Name = "gbdt";
Expand DownExpand Up@@ -355,6 +449,9 @@ public enum EvalMetricType
[Argument(ArgumentType.Multiple, HelpText = "Parallel LightGBM Learning Algorithm", ShortName = "parag")]
public ISupportParallel ParallelTrainer = new SingleTrainerFactory();

[Argument(ArgumentType.Multiple, HelpText = "Which execution device to use, can be cpu_device or gpu_device. Note: GPU device requires compatible build of LightGBM dll.", SortOrder = 3, ShortName = "device")]
public ISupportExecutionDeviceParameterFactory ExecutionDevice = new CpuExecutionDevice.Arguments();

internal Dictionary<string, object> ToDictionary(IHost host)
{
Contracts.CheckValue(host, nameof(host));
Expand DownExpand Up@@ -408,6 +505,10 @@ internal Dictionary<string, object> ToDictionary(IHost host)
res[GetArgName(nameof(MaxCatThreshold))] = MaxCatThreshold.ToString();
res[GetArgName(nameof(CatSmooth))] = CatSmooth.ToString();
res[GetArgName(nameof(CatL2))] = CatL2.ToString();

var executionDeviceParams = ExecutionDevice.CreateComponent(host);
executionDeviceParams.UpdateParameters(res);

return res;
}
}
Expand Down
68 changes: 67 additions & 1 deletion src/Microsoft.ML/CSharpApi.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -7599,6 +7599,14 @@ public sealed partial class LightGbmBinaryClassifier : Microsoft.ML.Runtime.Entr
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

might be worth moving this comment on the actual LightGBMArguments file, since this file is generated. Mabye on the ExecutionDevice classes.

[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -7806,6 +7814,14 @@ public sealed partial class LightGbmClassifier : Microsoft.ML.Runtime.EntryPoint
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -8013,6 +8029,14 @@ public sealed partial class LightGbmRanker : Microsoft.ML.Runtime.EntryPoints.Co
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -8220,6 +8244,14 @@ public sealed partial class LightGbmRegressor : Microsoft.ML.Runtime.EntryPoints
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -15985,8 +16017,42 @@ public sealed class AutoMlStateAutoMlStateBase : AutoMlStateBase
internal override string ComponentName => "AutoMlState";
}

public abstract class BoosterParameterFunction : ComponentKind {}
public abstract class LightGbmExecutionDevice : ComponentKind {}

/// <summary>
/// LightGBM CPU execution device
/// </summary>
public sealed class LightGbmCpuExecutionDevice : LightGbmExecutionDevice
{
internal override string ComponentName => "cpu_device";
}

/// <summary>
/// LightGBM GPU execution device.
/// NOTE: Requires build of LightGBM that supports GPU as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
public sealed class LightGbmGpuExecutionDevice : LightGbmExecutionDevice
{
/// <summary>
/// OpenCL platform ID. Usually each GPU vendor exposes one OpenCL platform. -1 means the system-wide default platform.
/// </summary>
public int PlatformId { get; set; } = -1;

/// <summary>
/// OpenCL device ID in the specified platform. Each GPU in the selected platform has a unique device ID. -1 means the default device in the selected platform.
/// </summary>
public int DeviceId { get; set; } = -1;

/// <summary>
/// Use double precision math on GPU?
/// </summary>
public bool UseDoublePrecision { get; set; } = false;

internal override string ComponentName => "gpu_device";
}

public abstract class BoosterParameterFunction : ComponentKind {}


/// <summary>
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
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
101 changes: 101 additions & 0 deletions src/Microsoft.ML.LightGBM/LightGbmArguments.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,21 +11,40 @@
using Microsoft.ML.Runtime.Internal.Internallearn;
using Microsoft.ML.Runtime.LightGBM;

[assembly: LoadableClass(typeof(LightGbmArguments.CpuExecutionDevice), typeof(LightGbmArguments.CpuExecutionDevice.Arguments),
typeof(SignatureLightGBMExecutionDevice), LightGbmArguments.CpuExecutionDevice.FriendlyName, LightGbmArguments.CpuExecutionDevice.Name)]
[assembly: LoadableClass(typeof(LightGbmArguments.GpuExecutionDevice), typeof(LightGbmArguments.GpuExecutionDevice.Arguments),
typeof(SignatureLightGBMExecutionDevice), LightGbmArguments.GpuExecutionDevice.FriendlyName, LightGbmArguments.GpuExecutionDevice.Name)]

[assembly: LoadableClass(typeof(LightGbmArguments.TreeBooster), typeof(LightGbmArguments.TreeBooster.Arguments),
typeof(SignatureLightGBMBooster), LightGbmArguments.TreeBooster.FriendlyName, LightGbmArguments.TreeBooster.Name)]
[assembly: LoadableClass(typeof(LightGbmArguments.DartBooster), typeof(LightGbmArguments.DartBooster.Arguments),
typeof(SignatureLightGBMBooster), LightGbmArguments.DartBooster.FriendlyName, LightGbmArguments.DartBooster.Name)]
[assembly: LoadableClass(typeof(LightGbmArguments.GossBooster), typeof(LightGbmArguments.GossBooster.Arguments),
typeof(SignatureLightGBMBooster), LightGbmArguments.GossBooster.FriendlyName, LightGbmArguments.GossBooster.Name)]

[assembly: EntryPointModule(typeof(LightGbmArguments.CpuExecutionDevice.Arguments))]
[assembly: EntryPointModule(typeof(LightGbmArguments.GpuExecutionDevice.Arguments))]

[assembly: EntryPointModule(typeof(LightGbmArguments.TreeBooster.Arguments))]
[assembly: EntryPointModule(typeof(LightGbmArguments.DartBooster.Arguments))]
[assembly: EntryPointModule(typeof(LightGbmArguments.GossBooster.Arguments))]

namespace Microsoft.ML.Runtime.LightGBM
{
public delegate void SignatureLightGBMExecutionDevice();

public delegate void SignatureLightGBMBooster();

[TlcModule.ComponentKind("LightGbmExecutionDevice")]
public interface ISupportExecutionDeviceParameterFactory : IComponentFactory<IExecutionDeviceParameter>
{
}
public interface IExecutionDeviceParameter
{
void UpdateParameters(Dictionary<string, object> res);
}

[TlcModule.ComponentKind("BoosterParameterFunction")]
public interface ISupportBoosterParameterFactory : IComponentFactory<IBoosterParameter>
{
Expand DownExpand Up@@ -62,6 +81,22 @@ public virtual void UpdateParameters(Dictionary<string, object> res)
}
}

public abstract class ExecutionDeviceParameter<TArgs> : IExecutionDeviceParameter
where TArgs : class, new()
{
protected TArgs Args { get; }

protected ExecutionDeviceParameter(TArgs args)
{
Args = args;
}

/// <summary>
/// Update the parameters by specific ExecutionDevice, will update parameters into "res" directly.
/// </summary>
public abstract void UpdateParameters(Dictionary<string, object> res);
}

private static string GetArgName(string name)
{
StringBuilder strBuf = new StringBuilder();
Expand All@@ -82,6 +117,65 @@ private static string GetArgName(string name)
return strBuf.ToString();
}


public sealed class CpuExecutionDevice : ExecutionDeviceParameter<CpuExecutionDevice.Arguments>
{
public const string Name = "cpu_device";
public const string FriendlyName = "CPU Device";

[TlcModule.Component(Name = Name, FriendlyName = FriendlyName, Desc = "LightGBM CPU device.")]
public class Arguments : ISupportExecutionDeviceParameterFactory
{
public virtual IExecutionDeviceParameter CreateComponent(IHostEnvironment env) => new CpuExecutionDevice(this);
}

public CpuExecutionDevice(Arguments args)
: base(args)
{
}

public override void UpdateParameters(Dictionary<string, object> res)
{
return;
}
}

public sealed class GpuExecutionDevice : ExecutionDeviceParameter<GpuExecutionDevice.Arguments>
{
public const string Name = "gpu_device";
public const string FriendlyName = "GPU Device";

[TlcModule.Component(Name = Name, FriendlyName = FriendlyName, Desc = "LightGBM GPU device.")]
public class Arguments : ISupportExecutionDeviceParameterFactory
{
[Argument(ArgumentType.AtMostOnce, HelpText = "OpenCL platform ID. Usually each GPU vendor exposes one OpenCL platform. -1 means the system-wide default platform.", ShortName = "gpu_platform_id")]
public int PlatformId = -1;

[Argument(ArgumentType.AtMostOnce, HelpText = "OpenCL device ID in the specified platform. Each GPU in the selected platform has a unique device ID. -1 means the default device in the selected platform.", ShortName = "gpu_device_id")]
public int DeviceId = -1;

[Argument(ArgumentType.AtMostOnce, HelpText = "Use double precision math on GPU?", ShortName = "gpu_use_dp")]
public bool UseDoublePrecision = false;

public virtual IExecutionDeviceParameter CreateComponent(IHostEnvironment env) => new GpuExecutionDevice(this);
}

public GpuExecutionDevice(Arguments args)
: base(args)
{
Contracts.CheckUserArg(Args.PlatformId >= -1, nameof(Args.PlatformId), "must be >= -1.");
Contracts.CheckUserArg(Args.DeviceId >= -1, nameof(Args.DeviceId), "must be >= -1.");
}

public override void UpdateParameters(Dictionary<string, object> res)
{
res["device"] = "gpu";
if (Args.PlatformId != -1) res["gpu_platform_id"] = Args.PlatformId.ToString();
if (Args.DeviceId != -1) res["gpu_device_id"] = Args.DeviceId.ToString();
if (Args.UseDoublePrecision) res["gpu_use_dp"] = Args.UseDoublePrecision.ToString();
}
}

public sealed class TreeBooster : BoosterParameter<TreeBooster.Arguments>
{
public const string Name = "gbdt";
Expand DownExpand Up@@ -355,6 +449,9 @@ public enum EvalMetricType
[Argument(ArgumentType.Multiple, HelpText = "Parallel LightGBM Learning Algorithm", ShortName = "parag")]
public ISupportParallel ParallelTrainer = new SingleTrainerFactory();

[Argument(ArgumentType.Multiple, HelpText = "Which execution device to use, can be cpu_device or gpu_device. Note: GPU device requires compatible build of LightGBM dll.", SortOrder = 3, ShortName = "device")]
public ISupportExecutionDeviceParameterFactory ExecutionDevice = new CpuExecutionDevice.Arguments();

internal Dictionary<string, object> ToDictionary(IHost host)
{
Contracts.CheckValue(host, nameof(host));
Expand DownExpand Up@@ -408,6 +505,10 @@ internal Dictionary<string, object> ToDictionary(IHost host)
res[GetArgName(nameof(MaxCatThreshold))] = MaxCatThreshold.ToString();
res[GetArgName(nameof(CatSmooth))] = CatSmooth.ToString();
res[GetArgName(nameof(CatL2))] = CatL2.ToString();

var executionDeviceParams = ExecutionDevice.CreateComponent(host);
executionDeviceParams.UpdateParameters(res);

return res;
}
}
Expand Down
68 changes: 67 additions & 1 deletion src/Microsoft.ML/CSharpApi.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -7599,6 +7599,14 @@ public sealed partial class LightGbmBinaryClassifier : Microsoft.ML.Runtime.Entr
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

might be worth moving this comment on the actual LightGBMArguments file, since this file is generated. Mabye on the ExecutionDevice classes.

[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -7806,6 +7814,14 @@ public sealed partial class LightGbmClassifier : Microsoft.ML.Runtime.EntryPoint
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -8013,6 +8029,14 @@ public sealed partial class LightGbmRanker : Microsoft.ML.Runtime.EntryPoints.Co
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -8220,6 +8244,14 @@ public sealed partial class LightGbmRegressor : Microsoft.ML.Runtime.EntryPoints
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -15985,8 +16017,42 @@ public sealed class AutoMlStateAutoMlStateBase : AutoMlStateBase
internal override string ComponentName => "AutoMlState";
}

public abstract class BoosterParameterFunction : ComponentKind {}
public abstract class LightGbmExecutionDevice : ComponentKind {}

/// <summary>
/// LightGBM CPU execution device
/// </summary>
public sealed class LightGbmCpuExecutionDevice : LightGbmExecutionDevice
{
internal override string ComponentName => "cpu_device";
}

/// <summary>
/// LightGBM GPU execution device.
/// NOTE: Requires build of LightGBM that supports GPU as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
public sealed class LightGbmGpuExecutionDevice : LightGbmExecutionDevice
{
/// <summary>
/// OpenCL platform ID. Usually each GPU vendor exposes one OpenCL platform. -1 means the system-wide default platform.
/// </summary>
public int PlatformId { get; set; } = -1;

/// <summary>
/// OpenCL device ID in the specified platform. Each GPU in the selected platform has a unique device ID. -1 means the default device in the selected platform.
/// </summary>
public int DeviceId { get; set; } = -1;

/// <summary>
/// Use double precision math on GPU?
/// </summary>
public bool UseDoublePrecision { get; set; } = false;

internal override string ComponentName => "gpu_device";
}

public abstract class BoosterParameterFunction : ComponentKind {}


/// <summary>
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Closed
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
101 changes: 101 additions & 0 deletions src/Microsoft.ML.LightGBM/LightGbmArguments.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,21 +11,40 @@
using Microsoft.ML.Runtime.Internal.Internallearn;
using Microsoft.ML.Runtime.LightGBM;

[assembly: LoadableClass(typeof(LightGbmArguments.CpuExecutionDevice), typeof(LightGbmArguments.CpuExecutionDevice.Arguments),
typeof(SignatureLightGBMExecutionDevice), LightGbmArguments.CpuExecutionDevice.FriendlyName, LightGbmArguments.CpuExecutionDevice.Name)]
[assembly: LoadableClass(typeof(LightGbmArguments.GpuExecutionDevice), typeof(LightGbmArguments.GpuExecutionDevice.Arguments),
typeof(SignatureLightGBMExecutionDevice), LightGbmArguments.GpuExecutionDevice.FriendlyName, LightGbmArguments.GpuExecutionDevice.Name)]

[assembly: LoadableClass(typeof(LightGbmArguments.TreeBooster), typeof(LightGbmArguments.TreeBooster.Arguments),
typeof(SignatureLightGBMBooster), LightGbmArguments.TreeBooster.FriendlyName, LightGbmArguments.TreeBooster.Name)]
[assembly: LoadableClass(typeof(LightGbmArguments.DartBooster), typeof(LightGbmArguments.DartBooster.Arguments),
typeof(SignatureLightGBMBooster), LightGbmArguments.DartBooster.FriendlyName, LightGbmArguments.DartBooster.Name)]
[assembly: LoadableClass(typeof(LightGbmArguments.GossBooster), typeof(LightGbmArguments.GossBooster.Arguments),
typeof(SignatureLightGBMBooster), LightGbmArguments.GossBooster.FriendlyName, LightGbmArguments.GossBooster.Name)]

[assembly: EntryPointModule(typeof(LightGbmArguments.CpuExecutionDevice.Arguments))]
[assembly: EntryPointModule(typeof(LightGbmArguments.GpuExecutionDevice.Arguments))]

[assembly: EntryPointModule(typeof(LightGbmArguments.TreeBooster.Arguments))]
[assembly: EntryPointModule(typeof(LightGbmArguments.DartBooster.Arguments))]
[assembly: EntryPointModule(typeof(LightGbmArguments.GossBooster.Arguments))]

namespace Microsoft.ML.Runtime.LightGBM
{
public delegate void SignatureLightGBMExecutionDevice();

public delegate void SignatureLightGBMBooster();

[TlcModule.ComponentKind("LightGbmExecutionDevice")]
public interface ISupportExecutionDeviceParameterFactory : IComponentFactory<IExecutionDeviceParameter>
{
}
public interface IExecutionDeviceParameter
{
void UpdateParameters(Dictionary<string, object> res);
}

[TlcModule.ComponentKind("BoosterParameterFunction")]
public interface ISupportBoosterParameterFactory : IComponentFactory<IBoosterParameter>
{
Expand DownExpand Up@@ -62,6 +81,22 @@ public virtual void UpdateParameters(Dictionary<string, object> res)
}
}

public abstract class ExecutionDeviceParameter<TArgs> : IExecutionDeviceParameter
where TArgs : class, new()
{
protected TArgs Args { get; }

protected ExecutionDeviceParameter(TArgs args)
{
Args = args;
}

/// <summary>
/// Update the parameters by specific ExecutionDevice, will update parameters into "res" directly.
/// </summary>
public abstract void UpdateParameters(Dictionary<string, object> res);
}

private static string GetArgName(string name)
{
StringBuilder strBuf = new StringBuilder();
Expand All@@ -82,6 +117,65 @@ private static string GetArgName(string name)
return strBuf.ToString();
}


public sealed class CpuExecutionDevice : ExecutionDeviceParameter<CpuExecutionDevice.Arguments>
{
public const string Name = "cpu_device";
public const string FriendlyName = "CPU Device";

[TlcModule.Component(Name = Name, FriendlyName = FriendlyName, Desc = "LightGBM CPU device.")]
public class Arguments : ISupportExecutionDeviceParameterFactory
{
public virtual IExecutionDeviceParameter CreateComponent(IHostEnvironment env) => new CpuExecutionDevice(this);
}

public CpuExecutionDevice(Arguments args)
: base(args)
{
}

public override void UpdateParameters(Dictionary<string, object> res)
{
return;
}
}

public sealed class GpuExecutionDevice : ExecutionDeviceParameter<GpuExecutionDevice.Arguments>
{
public const string Name = "gpu_device";
public const string FriendlyName = "GPU Device";

[TlcModule.Component(Name = Name, FriendlyName = FriendlyName, Desc = "LightGBM GPU device.")]
public class Arguments : ISupportExecutionDeviceParameterFactory
{
[Argument(ArgumentType.AtMostOnce, HelpText = "OpenCL platform ID. Usually each GPU vendor exposes one OpenCL platform. -1 means the system-wide default platform.", ShortName = "gpu_platform_id")]
public int PlatformId = -1;

[Argument(ArgumentType.AtMostOnce, HelpText = "OpenCL device ID in the specified platform. Each GPU in the selected platform has a unique device ID. -1 means the default device in the selected platform.", ShortName = "gpu_device_id")]
public int DeviceId = -1;

[Argument(ArgumentType.AtMostOnce, HelpText = "Use double precision math on GPU?", ShortName = "gpu_use_dp")]
public bool UseDoublePrecision = false;

public virtual IExecutionDeviceParameter CreateComponent(IHostEnvironment env) => new GpuExecutionDevice(this);
}

public GpuExecutionDevice(Arguments args)
: base(args)
{
Contracts.CheckUserArg(Args.PlatformId >= -1, nameof(Args.PlatformId), "must be >= -1.");
Contracts.CheckUserArg(Args.DeviceId >= -1, nameof(Args.DeviceId), "must be >= -1.");
}

public override void UpdateParameters(Dictionary<string, object> res)
{
res["device"] = "gpu";
if (Args.PlatformId != -1) res["gpu_platform_id"] = Args.PlatformId.ToString();
if (Args.DeviceId != -1) res["gpu_device_id"] = Args.DeviceId.ToString();
if (Args.UseDoublePrecision) res["gpu_use_dp"] = Args.UseDoublePrecision.ToString();
}
}

public sealed class TreeBooster : BoosterParameter<TreeBooster.Arguments>
{
public const string Name = "gbdt";
Expand DownExpand Up@@ -355,6 +449,9 @@ public enum EvalMetricType
[Argument(ArgumentType.Multiple, HelpText = "Parallel LightGBM Learning Algorithm", ShortName = "parag")]
public ISupportParallel ParallelTrainer = new SingleTrainerFactory();

[Argument(ArgumentType.Multiple, HelpText = "Which execution device to use, can be cpu_device or gpu_device. Note: GPU device requires compatible build of LightGBM dll.", SortOrder = 3, ShortName = "device")]
public ISupportExecutionDeviceParameterFactory ExecutionDevice = new CpuExecutionDevice.Arguments();

internal Dictionary<string, object> ToDictionary(IHost host)
{
Contracts.CheckValue(host, nameof(host));
Expand DownExpand Up@@ -408,6 +505,10 @@ internal Dictionary<string, object> ToDictionary(IHost host)
res[GetArgName(nameof(MaxCatThreshold))] = MaxCatThreshold.ToString();
res[GetArgName(nameof(CatSmooth))] = CatSmooth.ToString();
res[GetArgName(nameof(CatL2))] = CatL2.ToString();

var executionDeviceParams = ExecutionDevice.CreateComponent(host);
executionDeviceParams.UpdateParameters(res);

return res;
}
}
Expand Down
68 changes: 67 additions & 1 deletion src/Microsoft.ML/CSharpApi.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -7599,6 +7599,14 @@ public sealed partial class LightGbmBinaryClassifier : Microsoft.ML.Runtime.Entr
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

might be worth moving this comment on the actual LightGBMArguments file, since this file is generated. Mabye on the ExecutionDevice classes.

[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -7806,6 +7814,14 @@ public sealed partial class LightGbmClassifier : Microsoft.ML.Runtime.EntryPoint
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -8013,6 +8029,14 @@ public sealed partial class LightGbmRanker : Microsoft.ML.Runtime.EntryPoints.Co
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -8220,6 +8244,14 @@ public sealed partial class LightGbmRegressor : Microsoft.ML.Runtime.EntryPoints
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -15985,8 +16017,42 @@ public sealed class AutoMlStateAutoMlStateBase : AutoMlStateBase
internal override string ComponentName => "AutoMlState";
}

public abstract class BoosterParameterFunction : ComponentKind {}
public abstract class LightGbmExecutionDevice : ComponentKind {}

/// <summary>
/// LightGBM CPU execution device
/// </summary>
public sealed class LightGbmCpuExecutionDevice : LightGbmExecutionDevice
{
internal override string ComponentName => "cpu_device";
}

/// <summary>
/// LightGBM GPU execution device.
/// NOTE: Requires build of LightGBM that supports GPU as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
public sealed class LightGbmGpuExecutionDevice : LightGbmExecutionDevice
{
/// <summary>
/// OpenCL platform ID. Usually each GPU vendor exposes one OpenCL platform. -1 means the system-wide default platform.
/// </summary>
public int PlatformId { get; set; } = -1;

/// <summary>
/// OpenCL device ID in the specified platform. Each GPU in the selected platform has a unique device ID. -1 means the default device in the selected platform.
/// </summary>
public int DeviceId { get; set; } = -1;

/// <summary>
/// Use double precision math on GPU?
/// </summary>
public bool UseDoublePrecision { get; set; } = false;

internal override string ComponentName => "gpu_device";
}

public abstract class BoosterParameterFunction : ComponentKind {}


/// <summary>
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
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
101 changes: 101 additions & 0 deletions src/Microsoft.ML.LightGBM/LightGbmArguments.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,21 +11,40 @@
using Microsoft.ML.Runtime.Internal.Internallearn;
using Microsoft.ML.Runtime.LightGBM;

[assembly: LoadableClass(typeof(LightGbmArguments.CpuExecutionDevice), typeof(LightGbmArguments.CpuExecutionDevice.Arguments),
typeof(SignatureLightGBMExecutionDevice), LightGbmArguments.CpuExecutionDevice.FriendlyName, LightGbmArguments.CpuExecutionDevice.Name)]
[assembly: LoadableClass(typeof(LightGbmArguments.GpuExecutionDevice), typeof(LightGbmArguments.GpuExecutionDevice.Arguments),
typeof(SignatureLightGBMExecutionDevice), LightGbmArguments.GpuExecutionDevice.FriendlyName, LightGbmArguments.GpuExecutionDevice.Name)]

[assembly: LoadableClass(typeof(LightGbmArguments.TreeBooster), typeof(LightGbmArguments.TreeBooster.Arguments),
typeof(SignatureLightGBMBooster), LightGbmArguments.TreeBooster.FriendlyName, LightGbmArguments.TreeBooster.Name)]
[assembly: LoadableClass(typeof(LightGbmArguments.DartBooster), typeof(LightGbmArguments.DartBooster.Arguments),
typeof(SignatureLightGBMBooster), LightGbmArguments.DartBooster.FriendlyName, LightGbmArguments.DartBooster.Name)]
[assembly: LoadableClass(typeof(LightGbmArguments.GossBooster), typeof(LightGbmArguments.GossBooster.Arguments),
typeof(SignatureLightGBMBooster), LightGbmArguments.GossBooster.FriendlyName, LightGbmArguments.GossBooster.Name)]

[assembly: EntryPointModule(typeof(LightGbmArguments.CpuExecutionDevice.Arguments))]
[assembly: EntryPointModule(typeof(LightGbmArguments.GpuExecutionDevice.Arguments))]

[assembly: EntryPointModule(typeof(LightGbmArguments.TreeBooster.Arguments))]
[assembly: EntryPointModule(typeof(LightGbmArguments.DartBooster.Arguments))]
[assembly: EntryPointModule(typeof(LightGbmArguments.GossBooster.Arguments))]

namespace Microsoft.ML.Runtime.LightGBM
{
public delegate void SignatureLightGBMExecutionDevice();

public delegate void SignatureLightGBMBooster();

[TlcModule.ComponentKind("LightGbmExecutionDevice")]
public interface ISupportExecutionDeviceParameterFactory : IComponentFactory<IExecutionDeviceParameter>
{
}
public interface IExecutionDeviceParameter
{
void UpdateParameters(Dictionary<string, object> res);
}

[TlcModule.ComponentKind("BoosterParameterFunction")]
public interface ISupportBoosterParameterFactory : IComponentFactory<IBoosterParameter>
{
Expand DownExpand Up@@ -62,6 +81,22 @@ public virtual void UpdateParameters(Dictionary<string, object> res)
}
}

public abstract class ExecutionDeviceParameter<TArgs> : IExecutionDeviceParameter
where TArgs : class, new()
{
protected TArgs Args { get; }

protected ExecutionDeviceParameter(TArgs args)
{
Args = args;
}

/// <summary>
/// Update the parameters by specific ExecutionDevice, will update parameters into "res" directly.
/// </summary>
public abstract void UpdateParameters(Dictionary<string, object> res);
}

private static string GetArgName(string name)
{
StringBuilder strBuf = new StringBuilder();
Expand All@@ -82,6 +117,65 @@ private static string GetArgName(string name)
return strBuf.ToString();
}


public sealed class CpuExecutionDevice : ExecutionDeviceParameter<CpuExecutionDevice.Arguments>
{
public const string Name = "cpu_device";
public const string FriendlyName = "CPU Device";

[TlcModule.Component(Name = Name, FriendlyName = FriendlyName, Desc = "LightGBM CPU device.")]
public class Arguments : ISupportExecutionDeviceParameterFactory
{
public virtual IExecutionDeviceParameter CreateComponent(IHostEnvironment env) => new CpuExecutionDevice(this);
}

public CpuExecutionDevice(Arguments args)
: base(args)
{
}

public override void UpdateParameters(Dictionary<string, object> res)
{
return;
}
}

public sealed class GpuExecutionDevice : ExecutionDeviceParameter<GpuExecutionDevice.Arguments>
{
public const string Name = "gpu_device";
public const string FriendlyName = "GPU Device";

[TlcModule.Component(Name = Name, FriendlyName = FriendlyName, Desc = "LightGBM GPU device.")]
public class Arguments : ISupportExecutionDeviceParameterFactory
{
[Argument(ArgumentType.AtMostOnce, HelpText = "OpenCL platform ID. Usually each GPU vendor exposes one OpenCL platform. -1 means the system-wide default platform.", ShortName = "gpu_platform_id")]
public int PlatformId = -1;

[Argument(ArgumentType.AtMostOnce, HelpText = "OpenCL device ID in the specified platform. Each GPU in the selected platform has a unique device ID. -1 means the default device in the selected platform.", ShortName = "gpu_device_id")]
public int DeviceId = -1;

[Argument(ArgumentType.AtMostOnce, HelpText = "Use double precision math on GPU?", ShortName = "gpu_use_dp")]
public bool UseDoublePrecision = false;

public virtual IExecutionDeviceParameter CreateComponent(IHostEnvironment env) => new GpuExecutionDevice(this);
}

public GpuExecutionDevice(Arguments args)
: base(args)
{
Contracts.CheckUserArg(Args.PlatformId >= -1, nameof(Args.PlatformId), "must be >= -1.");
Contracts.CheckUserArg(Args.DeviceId >= -1, nameof(Args.DeviceId), "must be >= -1.");
}

public override void UpdateParameters(Dictionary<string, object> res)
{
res["device"] = "gpu";
if (Args.PlatformId != -1) res["gpu_platform_id"] = Args.PlatformId.ToString();
if (Args.DeviceId != -1) res["gpu_device_id"] = Args.DeviceId.ToString();
if (Args.UseDoublePrecision) res["gpu_use_dp"] = Args.UseDoublePrecision.ToString();
}
}

public sealed class TreeBooster : BoosterParameter<TreeBooster.Arguments>
{
public const string Name = "gbdt";
Expand DownExpand Up@@ -355,6 +449,9 @@ public enum EvalMetricType
[Argument(ArgumentType.Multiple, HelpText = "Parallel LightGBM Learning Algorithm", ShortName = "parag")]
public ISupportParallel ParallelTrainer = new SingleTrainerFactory();

[Argument(ArgumentType.Multiple, HelpText = "Which execution device to use, can be cpu_device or gpu_device. Note: GPU device requires compatible build of LightGBM dll.", SortOrder = 3, ShortName = "device")]
public ISupportExecutionDeviceParameterFactory ExecutionDevice = new CpuExecutionDevice.Arguments();

internal Dictionary<string, object> ToDictionary(IHost host)
{
Contracts.CheckValue(host, nameof(host));
Expand DownExpand Up@@ -408,6 +505,10 @@ internal Dictionary<string, object> ToDictionary(IHost host)
res[GetArgName(nameof(MaxCatThreshold))] = MaxCatThreshold.ToString();
res[GetArgName(nameof(CatSmooth))] = CatSmooth.ToString();
res[GetArgName(nameof(CatL2))] = CatL2.ToString();

var executionDeviceParams = ExecutionDevice.CreateComponent(host);
executionDeviceParams.UpdateParameters(res);

return res;
}
}
Expand Down
68 changes: 67 additions & 1 deletion src/Microsoft.ML/CSharpApi.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -7599,6 +7599,14 @@ public sealed partial class LightGbmBinaryClassifier : Microsoft.ML.Runtime.Entr
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

might be worth moving this comment on the actual LightGBMArguments file, since this file is generated. Mabye on the ExecutionDevice classes.

[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -7806,6 +7814,14 @@ public sealed partial class LightGbmClassifier : Microsoft.ML.Runtime.EntryPoint
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -8013,6 +8029,14 @@ public sealed partial class LightGbmRanker : Microsoft.ML.Runtime.EntryPoints.Co
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -8220,6 +8244,14 @@ public sealed partial class LightGbmRegressor : Microsoft.ML.Runtime.EntryPoints
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -15985,8 +16017,42 @@ public sealed class AutoMlStateAutoMlStateBase : AutoMlStateBase
internal override string ComponentName => "AutoMlState";
}

public abstract class BoosterParameterFunction : ComponentKind {}
public abstract class LightGbmExecutionDevice : ComponentKind {}

/// <summary>
/// LightGBM CPU execution device
/// </summary>
public sealed class LightGbmCpuExecutionDevice : LightGbmExecutionDevice
{
internal override string ComponentName => "cpu_device";
}

/// <summary>
/// LightGBM GPU execution device.
/// NOTE: Requires build of LightGBM that supports GPU as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
public sealed class LightGbmGpuExecutionDevice : LightGbmExecutionDevice
{
/// <summary>
/// OpenCL platform ID. Usually each GPU vendor exposes one OpenCL platform. -1 means the system-wide default platform.
/// </summary>
public int PlatformId { get; set; } = -1;

/// <summary>
/// OpenCL device ID in the specified platform. Each GPU in the selected platform has a unique device ID. -1 means the default device in the selected platform.
/// </summary>
public int DeviceId { get; set; } = -1;

/// <summary>
/// Use double precision math on GPU?
/// </summary>
public bool UseDoublePrecision { get; set; } = false;

internal override string ComponentName => "gpu_device";
}

public abstract class BoosterParameterFunction : ComponentKind {}


/// <summary>
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
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
101 changes: 101 additions & 0 deletions src/Microsoft.ML.LightGBM/LightGbmArguments.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,21 +11,40 @@
using Microsoft.ML.Runtime.Internal.Internallearn;
using Microsoft.ML.Runtime.LightGBM;

[assembly: LoadableClass(typeof(LightGbmArguments.CpuExecutionDevice), typeof(LightGbmArguments.CpuExecutionDevice.Arguments),
typeof(SignatureLightGBMExecutionDevice), LightGbmArguments.CpuExecutionDevice.FriendlyName, LightGbmArguments.CpuExecutionDevice.Name)]
[assembly: LoadableClass(typeof(LightGbmArguments.GpuExecutionDevice), typeof(LightGbmArguments.GpuExecutionDevice.Arguments),
typeof(SignatureLightGBMExecutionDevice), LightGbmArguments.GpuExecutionDevice.FriendlyName, LightGbmArguments.GpuExecutionDevice.Name)]

[assembly: LoadableClass(typeof(LightGbmArguments.TreeBooster), typeof(LightGbmArguments.TreeBooster.Arguments),
typeof(SignatureLightGBMBooster), LightGbmArguments.TreeBooster.FriendlyName, LightGbmArguments.TreeBooster.Name)]
[assembly: LoadableClass(typeof(LightGbmArguments.DartBooster), typeof(LightGbmArguments.DartBooster.Arguments),
typeof(SignatureLightGBMBooster), LightGbmArguments.DartBooster.FriendlyName, LightGbmArguments.DartBooster.Name)]
[assembly: LoadableClass(typeof(LightGbmArguments.GossBooster), typeof(LightGbmArguments.GossBooster.Arguments),
typeof(SignatureLightGBMBooster), LightGbmArguments.GossBooster.FriendlyName, LightGbmArguments.GossBooster.Name)]

[assembly: EntryPointModule(typeof(LightGbmArguments.CpuExecutionDevice.Arguments))]
[assembly: EntryPointModule(typeof(LightGbmArguments.GpuExecutionDevice.Arguments))]

[assembly: EntryPointModule(typeof(LightGbmArguments.TreeBooster.Arguments))]
[assembly: EntryPointModule(typeof(LightGbmArguments.DartBooster.Arguments))]
[assembly: EntryPointModule(typeof(LightGbmArguments.GossBooster.Arguments))]

namespace Microsoft.ML.Runtime.LightGBM
{
public delegate void SignatureLightGBMExecutionDevice();

public delegate void SignatureLightGBMBooster();

[TlcModule.ComponentKind("LightGbmExecutionDevice")]
public interface ISupportExecutionDeviceParameterFactory : IComponentFactory<IExecutionDeviceParameter>
{
}
public interface IExecutionDeviceParameter
{
void UpdateParameters(Dictionary<string, object> res);
}

[TlcModule.ComponentKind("BoosterParameterFunction")]
public interface ISupportBoosterParameterFactory : IComponentFactory<IBoosterParameter>
{
Expand DownExpand Up@@ -62,6 +81,22 @@ public virtual void UpdateParameters(Dictionary<string, object> res)
}
}

public abstract class ExecutionDeviceParameter<TArgs> : IExecutionDeviceParameter
where TArgs : class, new()
{
protected TArgs Args { get; }

protected ExecutionDeviceParameter(TArgs args)
{
Args = args;
}

/// <summary>
/// Update the parameters by specific ExecutionDevice, will update parameters into "res" directly.
/// </summary>
public abstract void UpdateParameters(Dictionary<string, object> res);
}

private static string GetArgName(string name)
{
StringBuilder strBuf = new StringBuilder();
Expand All@@ -82,6 +117,65 @@ private static string GetArgName(string name)
return strBuf.ToString();
}


public sealed class CpuExecutionDevice : ExecutionDeviceParameter<CpuExecutionDevice.Arguments>
{
public const string Name = "cpu_device";
public const string FriendlyName = "CPU Device";

[TlcModule.Component(Name = Name, FriendlyName = FriendlyName, Desc = "LightGBM CPU device.")]
public class Arguments : ISupportExecutionDeviceParameterFactory
{
public virtual IExecutionDeviceParameter CreateComponent(IHostEnvironment env) => new CpuExecutionDevice(this);
}

public CpuExecutionDevice(Arguments args)
: base(args)
{
}

public override void UpdateParameters(Dictionary<string, object> res)
{
return;
}
}

public sealed class GpuExecutionDevice : ExecutionDeviceParameter<GpuExecutionDevice.Arguments>
{
public const string Name = "gpu_device";
public const string FriendlyName = "GPU Device";

[TlcModule.Component(Name = Name, FriendlyName = FriendlyName, Desc = "LightGBM GPU device.")]
public class Arguments : ISupportExecutionDeviceParameterFactory
{
[Argument(ArgumentType.AtMostOnce, HelpText = "OpenCL platform ID. Usually each GPU vendor exposes one OpenCL platform. -1 means the system-wide default platform.", ShortName = "gpu_platform_id")]
public int PlatformId = -1;

[Argument(ArgumentType.AtMostOnce, HelpText = "OpenCL device ID in the specified platform. Each GPU in the selected platform has a unique device ID. -1 means the default device in the selected platform.", ShortName = "gpu_device_id")]
public int DeviceId = -1;

[Argument(ArgumentType.AtMostOnce, HelpText = "Use double precision math on GPU?", ShortName = "gpu_use_dp")]
public bool UseDoublePrecision = false;

public virtual IExecutionDeviceParameter CreateComponent(IHostEnvironment env) => new GpuExecutionDevice(this);
}

public GpuExecutionDevice(Arguments args)
: base(args)
{
Contracts.CheckUserArg(Args.PlatformId >= -1, nameof(Args.PlatformId), "must be >= -1.");
Contracts.CheckUserArg(Args.DeviceId >= -1, nameof(Args.DeviceId), "must be >= -1.");
}

public override void UpdateParameters(Dictionary<string, object> res)
{
res["device"] = "gpu";
if (Args.PlatformId != -1) res["gpu_platform_id"] = Args.PlatformId.ToString();
if (Args.DeviceId != -1) res["gpu_device_id"] = Args.DeviceId.ToString();
if (Args.UseDoublePrecision) res["gpu_use_dp"] = Args.UseDoublePrecision.ToString();
}
}

public sealed class TreeBooster : BoosterParameter<TreeBooster.Arguments>
{
public const string Name = "gbdt";
Expand DownExpand Up@@ -355,6 +449,9 @@ public enum EvalMetricType
[Argument(ArgumentType.Multiple, HelpText = "Parallel LightGBM Learning Algorithm", ShortName = "parag")]
public ISupportParallel ParallelTrainer = new SingleTrainerFactory();

[Argument(ArgumentType.Multiple, HelpText = "Which execution device to use, can be cpu_device or gpu_device. Note: GPU device requires compatible build of LightGBM dll.", SortOrder = 3, ShortName = "device")]
public ISupportExecutionDeviceParameterFactory ExecutionDevice = new CpuExecutionDevice.Arguments();

internal Dictionary<string, object> ToDictionary(IHost host)
{
Contracts.CheckValue(host, nameof(host));
Expand DownExpand Up@@ -408,6 +505,10 @@ internal Dictionary<string, object> ToDictionary(IHost host)
res[GetArgName(nameof(MaxCatThreshold))] = MaxCatThreshold.ToString();
res[GetArgName(nameof(CatSmooth))] = CatSmooth.ToString();
res[GetArgName(nameof(CatL2))] = CatL2.ToString();

var executionDeviceParams = ExecutionDevice.CreateComponent(host);
executionDeviceParams.UpdateParameters(res);

return res;
}
}
Expand Down
68 changes: 67 additions & 1 deletion src/Microsoft.ML/CSharpApi.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -7599,6 +7599,14 @@ public sealed partial class LightGbmBinaryClassifier : Microsoft.ML.Runtime.Entr
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

might be worth moving this comment on the actual LightGBMArguments file, since this file is generated. Mabye on the ExecutionDevice classes.

[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -7806,6 +7814,14 @@ public sealed partial class LightGbmClassifier : Microsoft.ML.Runtime.EntryPoint
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -8013,6 +8029,14 @@ public sealed partial class LightGbmRanker : Microsoft.ML.Runtime.EntryPoints.Co
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -8220,6 +8244,14 @@ public sealed partial class LightGbmRegressor : Microsoft.ML.Runtime.EntryPoints
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -15985,8 +16017,42 @@ public sealed class AutoMlStateAutoMlStateBase : AutoMlStateBase
internal override string ComponentName => "AutoMlState";
}

public abstract class BoosterParameterFunction : ComponentKind {}
public abstract class LightGbmExecutionDevice : ComponentKind {}

/// <summary>
/// LightGBM CPU execution device
/// </summary>
public sealed class LightGbmCpuExecutionDevice : LightGbmExecutionDevice
{
internal override string ComponentName => "cpu_device";
}

/// <summary>
/// LightGBM GPU execution device.
/// NOTE: Requires build of LightGBM that supports GPU as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
public sealed class LightGbmGpuExecutionDevice : LightGbmExecutionDevice
{
/// <summary>
/// OpenCL platform ID. Usually each GPU vendor exposes one OpenCL platform. -1 means the system-wide default platform.
/// </summary>
public int PlatformId { get; set; } = -1;

/// <summary>
/// OpenCL device ID in the specified platform. Each GPU in the selected platform has a unique device ID. -1 means the default device in the selected platform.
/// </summary>
public int DeviceId { get; set; } = -1;

/// <summary>
/// Use double precision math on GPU?
/// </summary>
public bool UseDoublePrecision { get; set; } = false;

internal override string ComponentName => "gpu_device";
}

public abstract class BoosterParameterFunction : ComponentKind {}


/// <summary>
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Closed
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
101 changes: 101 additions & 0 deletions src/Microsoft.ML.LightGBM/LightGbmArguments.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,21 +11,40 @@
using Microsoft.ML.Runtime.Internal.Internallearn;
using Microsoft.ML.Runtime.LightGBM;

[assembly: LoadableClass(typeof(LightGbmArguments.CpuExecutionDevice), typeof(LightGbmArguments.CpuExecutionDevice.Arguments),
typeof(SignatureLightGBMExecutionDevice), LightGbmArguments.CpuExecutionDevice.FriendlyName, LightGbmArguments.CpuExecutionDevice.Name)]
[assembly: LoadableClass(typeof(LightGbmArguments.GpuExecutionDevice), typeof(LightGbmArguments.GpuExecutionDevice.Arguments),
typeof(SignatureLightGBMExecutionDevice), LightGbmArguments.GpuExecutionDevice.FriendlyName, LightGbmArguments.GpuExecutionDevice.Name)]

[assembly: LoadableClass(typeof(LightGbmArguments.TreeBooster), typeof(LightGbmArguments.TreeBooster.Arguments),
typeof(SignatureLightGBMBooster), LightGbmArguments.TreeBooster.FriendlyName, LightGbmArguments.TreeBooster.Name)]
[assembly: LoadableClass(typeof(LightGbmArguments.DartBooster), typeof(LightGbmArguments.DartBooster.Arguments),
typeof(SignatureLightGBMBooster), LightGbmArguments.DartBooster.FriendlyName, LightGbmArguments.DartBooster.Name)]
[assembly: LoadableClass(typeof(LightGbmArguments.GossBooster), typeof(LightGbmArguments.GossBooster.Arguments),
typeof(SignatureLightGBMBooster), LightGbmArguments.GossBooster.FriendlyName, LightGbmArguments.GossBooster.Name)]

[assembly: EntryPointModule(typeof(LightGbmArguments.CpuExecutionDevice.Arguments))]
[assembly: EntryPointModule(typeof(LightGbmArguments.GpuExecutionDevice.Arguments))]

[assembly: EntryPointModule(typeof(LightGbmArguments.TreeBooster.Arguments))]
[assembly: EntryPointModule(typeof(LightGbmArguments.DartBooster.Arguments))]
[assembly: EntryPointModule(typeof(LightGbmArguments.GossBooster.Arguments))]

namespace Microsoft.ML.Runtime.LightGBM
{
public delegate void SignatureLightGBMExecutionDevice();

public delegate void SignatureLightGBMBooster();

[TlcModule.ComponentKind("LightGbmExecutionDevice")]
public interface ISupportExecutionDeviceParameterFactory : IComponentFactory<IExecutionDeviceParameter>
{
}
public interface IExecutionDeviceParameter
{
void UpdateParameters(Dictionary<string, object> res);
}

[TlcModule.ComponentKind("BoosterParameterFunction")]
public interface ISupportBoosterParameterFactory : IComponentFactory<IBoosterParameter>
{
Expand DownExpand Up@@ -62,6 +81,22 @@ public virtual void UpdateParameters(Dictionary<string, object> res)
}
}

public abstract class ExecutionDeviceParameter<TArgs> : IExecutionDeviceParameter
where TArgs : class, new()
{
protected TArgs Args { get; }

protected ExecutionDeviceParameter(TArgs args)
{
Args = args;
}

/// <summary>
/// Update the parameters by specific ExecutionDevice, will update parameters into "res" directly.
/// </summary>
public abstract void UpdateParameters(Dictionary<string, object> res);
}

private static string GetArgName(string name)
{
StringBuilder strBuf = new StringBuilder();
Expand All@@ -82,6 +117,65 @@ private static string GetArgName(string name)
return strBuf.ToString();
}


public sealed class CpuExecutionDevice : ExecutionDeviceParameter<CpuExecutionDevice.Arguments>
{
public const string Name = "cpu_device";
public const string FriendlyName = "CPU Device";

[TlcModule.Component(Name = Name, FriendlyName = FriendlyName, Desc = "LightGBM CPU device.")]
public class Arguments : ISupportExecutionDeviceParameterFactory
{
public virtual IExecutionDeviceParameter CreateComponent(IHostEnvironment env) => new CpuExecutionDevice(this);
}

public CpuExecutionDevice(Arguments args)
: base(args)
{
}

public override void UpdateParameters(Dictionary<string, object> res)
{
return;
}
}

public sealed class GpuExecutionDevice : ExecutionDeviceParameter<GpuExecutionDevice.Arguments>
{
public const string Name = "gpu_device";
public const string FriendlyName = "GPU Device";

[TlcModule.Component(Name = Name, FriendlyName = FriendlyName, Desc = "LightGBM GPU device.")]
public class Arguments : ISupportExecutionDeviceParameterFactory
{
[Argument(ArgumentType.AtMostOnce, HelpText = "OpenCL platform ID. Usually each GPU vendor exposes one OpenCL platform. -1 means the system-wide default platform.", ShortName = "gpu_platform_id")]
public int PlatformId = -1;

[Argument(ArgumentType.AtMostOnce, HelpText = "OpenCL device ID in the specified platform. Each GPU in the selected platform has a unique device ID. -1 means the default device in the selected platform.", ShortName = "gpu_device_id")]
public int DeviceId = -1;

[Argument(ArgumentType.AtMostOnce, HelpText = "Use double precision math on GPU?", ShortName = "gpu_use_dp")]
public bool UseDoublePrecision = false;

public virtual IExecutionDeviceParameter CreateComponent(IHostEnvironment env) => new GpuExecutionDevice(this);
}

public GpuExecutionDevice(Arguments args)
: base(args)
{
Contracts.CheckUserArg(Args.PlatformId >= -1, nameof(Args.PlatformId), "must be >= -1.");
Contracts.CheckUserArg(Args.DeviceId >= -1, nameof(Args.DeviceId), "must be >= -1.");
}

public override void UpdateParameters(Dictionary<string, object> res)
{
res["device"] = "gpu";
if (Args.PlatformId != -1) res["gpu_platform_id"] = Args.PlatformId.ToString();
if (Args.DeviceId != -1) res["gpu_device_id"] = Args.DeviceId.ToString();
if (Args.UseDoublePrecision) res["gpu_use_dp"] = Args.UseDoublePrecision.ToString();
}
}

public sealed class TreeBooster : BoosterParameter<TreeBooster.Arguments>
{
public const string Name = "gbdt";
Expand DownExpand Up@@ -355,6 +449,9 @@ public enum EvalMetricType
[Argument(ArgumentType.Multiple, HelpText = "Parallel LightGBM Learning Algorithm", ShortName = "parag")]
public ISupportParallel ParallelTrainer = new SingleTrainerFactory();

[Argument(ArgumentType.Multiple, HelpText = "Which execution device to use, can be cpu_device or gpu_device. Note: GPU device requires compatible build of LightGBM dll.", SortOrder = 3, ShortName = "device")]
public ISupportExecutionDeviceParameterFactory ExecutionDevice = new CpuExecutionDevice.Arguments();

internal Dictionary<string, object> ToDictionary(IHost host)
{
Contracts.CheckValue(host, nameof(host));
Expand DownExpand Up@@ -408,6 +505,10 @@ internal Dictionary<string, object> ToDictionary(IHost host)
res[GetArgName(nameof(MaxCatThreshold))] = MaxCatThreshold.ToString();
res[GetArgName(nameof(CatSmooth))] = CatSmooth.ToString();
res[GetArgName(nameof(CatL2))] = CatL2.ToString();

var executionDeviceParams = ExecutionDevice.CreateComponent(host);
executionDeviceParams.UpdateParameters(res);

return res;
}
}
Expand Down
68 changes: 67 additions & 1 deletion src/Microsoft.ML/CSharpApi.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -7599,6 +7599,14 @@ public sealed partial class LightGbmBinaryClassifier : Microsoft.ML.Runtime.Entr
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

might be worth moving this comment on the actual LightGBMArguments file, since this file is generated. Mabye on the ExecutionDevice classes.

[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -7806,6 +7814,14 @@ public sealed partial class LightGbmClassifier : Microsoft.ML.Runtime.EntryPoint
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -8013,6 +8029,14 @@ public sealed partial class LightGbmRanker : Microsoft.ML.Runtime.EntryPoints.Co
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -8220,6 +8244,14 @@ public sealed partial class LightGbmRegressor : Microsoft.ML.Runtime.EntryPoints
[TlcModule.SweepableDiscreteParamAttribute("CatL2", new object[]{0.1f, 0.5f, 1, 5, 10})]
public double CatL2 { get; set; } = 10d;

/// <summary>
/// Execution device for training (CPU or GPU).
/// NOTE: GPU training requires compatible build of LightGBM as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
[JsonConverter(typeof(ComponentSerializer))]
public LightGbmExecutionDevice ExecutionDevice { get; set; } = new LightGbmCpuExecutionDevice();

/// <summary>
/// Parallel LightGBM Learning Algorithm
/// </summary>
Expand DownExpand Up@@ -15985,8 +16017,42 @@ public sealed class AutoMlStateAutoMlStateBase : AutoMlStateBase
internal override string ComponentName => "AutoMlState";
}

public abstract class BoosterParameterFunction : ComponentKind {}
public abstract class LightGbmExecutionDevice : ComponentKind {}

/// <summary>
/// LightGBM CPU execution device
/// </summary>
public sealed class LightGbmCpuExecutionDevice : LightGbmExecutionDevice
{
internal override string ComponentName => "cpu_device";
}

/// <summary>
/// LightGBM GPU execution device.
/// NOTE: Requires build of LightGBM that supports GPU as described here:
/// https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version
/// </summary>
public sealed class LightGbmGpuExecutionDevice : LightGbmExecutionDevice
{
/// <summary>
/// OpenCL platform ID. Usually each GPU vendor exposes one OpenCL platform. -1 means the system-wide default platform.
/// </summary>
public int PlatformId { get; set; } = -1;

/// <summary>
/// OpenCL device ID in the specified platform. Each GPU in the selected platform has a unique device ID. -1 means the default device in the selected platform.
/// </summary>
public int DeviceId { get; set; } = -1;

/// <summary>
/// Use double precision math on GPU?
/// </summary>
public bool UseDoublePrecision { get; set; } = false;

internal override string ComponentName => "gpu_device";
}

public abstract class BoosterParameterFunction : ComponentKind {}


/// <summary>
Expand Down