AI Dev Kit
Search Results for

    Show / Hide Table of Contents

    Class Dataset

    Dataset for training or validation.

    Inheritance
    object
    Dataset
    Implements
    ICollection<TuningExample>
    IEnumerable<TuningExample>
    Namespace: Glitch9.AIDevKit.Google
    Assembly: .dll
    Syntax
    public class Dataset : ICollection<TuningExample>, IEnumerable<TuningExample>

    Properties

    Count

    Gets the number of elements contained in the System.Collections.Generic.ICollection<T>.

    Declaration
    public int Count { get; }
    Property Value
    Type Description
    int

    The number of elements contained in the System.Collections.Generic.ICollection<T>.

    Examples

    Optional. Inline examples.

    Declaration
    public TuningExamples Examples { get; set; }
    Property Value
    Type Description
    TuningExamples

    IsReadOnly

    Gets a value indicating whether the System.Collections.Generic.ICollection<T> is read-only.

    Declaration
    public bool IsReadOnly { get; }
    Property Value
    Type Description
    bool

    true if the System.Collections.Generic.ICollection<T> is read-only; otherwise, false.

    Methods

    Add(TuningExample)

    Adds an item to the System.Collections.Generic.ICollection<T>.

    Declaration
    public void Add(TuningExample item)
    Parameters
    Type Name Description
    TuningExample item

    The object to add to the System.Collections.Generic.ICollection<T>.

    Exceptions
    Type Condition
    NotSupportedException

    The System.Collections.Generic.ICollection<T> is read-only.

    AddRange(IEnumerable<TuningExample>)

    Declaration
    public void AddRange(IEnumerable<TuningExample> items)
    Parameters
    Type Name Description
    IEnumerable<TuningExample> items

    Clear()

    Removes all items from the System.Collections.Generic.ICollection<T>.

    Declaration
    public void Clear()
    Exceptions
    Type Condition
    NotSupportedException

    The System.Collections.Generic.ICollection<T> is read-only.

    Contains(TuningExample)

    Determines whether the System.Collections.Generic.ICollection<T> contains a specific value.

    Declaration
    public bool Contains(TuningExample item)
    Parameters
    Type Name Description
    TuningExample item

    The object to locate in the System.Collections.Generic.ICollection<T>.

    Returns
    Type Description
    bool

    true if item is found in the System.Collections.Generic.ICollection<T>; otherwise, false.

    CopyTo(TuningExample[], int)

    Copies the elements of the System.Collections.Generic.ICollection<T> to an System.Array, starting at a particular System.Array index.

    Declaration
    public void CopyTo(TuningExample[] array, int arrayIndex)
    Parameters
    Type Name Description
    TuningExample[] array

    The one-dimensional System.Array that is the destination of the elements copied from System.Collections.Generic.ICollection<T>. The System.Array must have zero-based indexing.

    int arrayIndex

    The zero-based index in array at which copying begins.

    Exceptions
    Type Condition
    ArgumentNullException

    array is null.

    ArgumentOutOfRangeException

    arrayIndex is less than 0.

    ArgumentException

    The number of elements in the source System.Collections.Generic.ICollection<T> is greater than the available space from arrayIndex to the end of the destination array.

    GetEnumerator()

    Returns an enumerator that iterates through the collection.

    Declaration
    public IEnumerator<TuningExample> GetEnumerator()
    Returns
    Type Description
    IEnumerator<TuningExample>

    An enumerator that can be used to iterate through the collection.

    Remove(TuningExample)

    Removes the first occurrence of a specific object from the System.Collections.Generic.ICollection<T>.

    Declaration
    public bool Remove(TuningExample item)
    Parameters
    Type Name Description
    TuningExample item

    The object to remove from the System.Collections.Generic.ICollection<T>.

    Returns
    Type Description
    bool

    true if item was successfully removed from the System.Collections.Generic.ICollection<T>; otherwise, false. This method also returns false if item is not found in the original System.Collections.Generic.ICollection<T>.

    Exceptions
    Type Condition
    NotSupportedException

    The System.Collections.Generic.ICollection<T> is read-only.

    Implements

    System.Collections.Generic.ICollection<T>
    System.Collections.Generic.IEnumerable<T>

    Extension Methods

    RequestExtensions.AddTrainingData(Dataset, params TuningExample[])
    In this article
    Back to top Generated by DocFX