Parameter Class

Reference

Definition

Namespace:: Microsoft.ML.SearchSpace

Assembly:: Microsoft.ML.SearchSpace.dll

Package:: Microsoft.ML.AutoML v0.21.1

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Parameter is used to save sweeping result from tuner and is used to restore mlnet pipeline from sweepable pipline.

[System.Text.Json.Serialization.JsonConverter(typeof(Microsoft.ML.SearchSpace.Converter.ParameterConverter))]
public sealed class Parameter : IEquatable<Microsoft.ML.SearchSpace.Parameter>, System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<string,Microsoft.ML.SearchSpace.Parameter>>, System.Collections.Generic.IDictionary<string,Microsoft.ML.SearchSpace.Parameter>, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string,Microsoft.ML.SearchSpace.Parameter>>, System.Collections.Generic.IEqualityComparer<Microsoft.ML.SearchSpace.Parameter>

[<System.Text.Json.Serialization.JsonConverter(typeof(Microsoft.ML.SearchSpace.Converter.ParameterConverter))>]
type Parameter = class
    interface IDictionary<string, Parameter>
    interface ICollection<KeyValuePair<string, Parameter>>
    interface seq<KeyValuePair<string, Parameter>>
    interface IEnumerable
    interface IEquatable<Parameter>
    interface IEqualityComparer<Parameter>

Public NotInheritable Class Parameter
Implements ICollection(Of KeyValuePair(Of String, Parameter)), IDictionary(Of String, Parameter), IEnumerable(Of KeyValuePair(Of String, Parameter)), IEqualityComparer(Of Parameter), IEquatable(Of Parameter)

Inheritance: Object
Parameter

Attributes: JsonConverterAttribute

Implements: ICollection<KeyValuePair<String,Parameter>> ICollection<KeyValuePair<TKey,TValue>> IDictionary<String,Parameter> IEnumerable<KeyValuePair<String,Parameter>> IEnumerable<KeyValuePair<TKey,TValue>> IEnumerable<T> IEqualityComparer<Parameter> IEnumerable IEquatable<Parameter>

Properties

Count	Gets the number of elements contained in the ICollection<T>.
IsReadOnly	Gets a value indicating whether the ICollection<T> is read-only.
Item[String]	Gets or sets the element with the specified key.
Keys	Gets an ICollection<T> containing the keys of the IDictionary<TKey,TValue>.
ParameterType	Get ParameterType of this ParameterType

Methods

Add(KeyValuePair<String,Parameter>)	Adds an item to the ICollection<T>.
Add(String, Parameter)	Adds an element with the provided key and value to the IDictionary<TKey,TValue>.
AsType<T>()	Cast ParameterType to `T`. This method will return immediately if the underlying value is of type `T`, otherwise it uses JsonSerializer to convert its value to `T`.
Clear()	Removes all items from the ICollection<T>.
Contains(KeyValuePair<String,Parameter>)	Determines whether the ICollection<T> contains a specific value.
ContainsKey(String)	Determines whether the IDictionary<TKey,TValue> contains an element with the specified key.
CopyTo(KeyValuePair<String,Parameter>[], Int32)	Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.
CreateNestedParameter(KeyValuePair<String,Parameter>[])	Create a Parameter from `parameters`. The ParameterType will be Object.
Equals(Parameter, Parameter)	Determines wether two Parameter objects have the same value.
Equals(Parameter)	Indicates whether the current object is equal to another object of the same type.
FromBool(Boolean)	Create a Parameter from a Boolean value. The ParameterType will be Bool.
FromDouble(Double)	Create a Parameter from a Double value. The ParameterType will be Number.
FromEnum<T>(T)	Create a Parameter from a Enum value. The ParameterType will be String.
FromFloat(Single)	Create a Parameter from a Single value. The ParameterType will be Number.
FromIEnumerable<T>(IEnumerable<T>)	Create a Parameter from a IEnumerable value. The ParameterType will be Array.
FromInt(Int32)	Create a Parameter from a Int32 value. The ParameterType will be Integer.
FromLong(Int64)	Create a Parameter from a Int64 value. The ParameterType will be Integer.
FromObject<T>(T)	Create a Parameter from an Object value. The ParameterType will be Object.
FromString(String)	Create a Parameter from a String value. The ParameterType will be String.
GetHashCode()	Serves as the default hash function.
GetHashCode(Parameter)	Returns a hash code for the specified object.
Remove(KeyValuePair<String,Parameter>)	Removes the first occurrence of a specific object from the ICollection<T>.
Remove(String)	Removes the element with the specified key from the IDictionary<TKey,TValue>.
ToString()	Returns a string that represents the current object.
TryGetValue(String, Parameter)	System.Object.TryGetValue(System.String,System.Object@)

Explicit Interface Implementations

IDictionary<String,Parameter>.Values
IEnumerable.GetEnumerator()	Returns an enumerator that iterates through a collection.
IEnumerable<KeyValuePair<String,Parameter>>.GetEnumerator()	Returns an enumerator that iterates through the collection.

Applies to

Share via