[source]

Labeled#

A Labeled dataset is used to train supervised learners and for testing a model by providing the ground-truth. In addition to the standard dataset API, a Labeled dataset can perform operations such as stratification and sorting the dataset using the label column.

Parameters#

# Param Default Type Description
1 samples array A 2-dimensional array consisting of rows of samples and columns with feature values.
2 labels array A 1-dimensional array of labels that correspond to each sample in the dataset.
3 validate true bool Should we validate the data?

Additional Methods#

Selectors#

Return an array of labels:

public labels() : array

Return a single label at the given row offset:

public label(int $offset) : mixed

Return the data type of the label:

public labelType() : DataType

Return all of the possible outcomes i.e. the unique labels in an array:

public possibleOutcomes() : array

Examples

var_dump($dataset->labels());

var_dump($dataset->label(3));

var_dump($dataset->possibleOutcomes());
array(4) {
    [0]=> string(5) "female"
    [1]=> string(4) "male"
    [2]=> string(5) "female"
    [3]=> string(4) "male"
}

string(4) "male"

array(2) {
    [0]=> string(5) "female"
    [1]=> string(4) "male"
}

Stratification#

Group samples by their class label and return them in their own dataset:

public stratify() : array

Split the dataset into left and right subsets such that the proportions of class labels remain intact:

public stratifiedSplit($ratio = 0.5) : array

Return k equal size subsets of the dataset such that class proportions remain intact:

public stratifiedFold($k = 10) : array

Transform Labels#

Transform the labels in the dataset using a callback function and return self for method chaining:

public transformLabels(callable $fn) : self

Note: The callback function is given a label as its only argument and should return the transformed label as a continuous or categorical value.

Examples

$dataset->transformLabels('intval');

$dataset->transformLabels('floatval');

$dataset->transformLabels(function ($label) {
    switch ($label) {
        case 0:
            return 'disagree';

        case 1:
            return 'neutral';

        case 2:
            return 'agree';

        default:
            return '?';
    }
});

$dataset->transformLabels(function ($label) {
    return $label > 0.5 ? 'yes' : 'no';
});

Filter#

Filter the dataset by label:

public filterByLabel(callable $fn) : self

Note: The callback function is given a label as its only argument and should return true if the row should be kept or false if the row should be filtered out of the result.

Example

$filtered = $dataset->filterByLabel(function ($label)) {
    return $label > 10000 ? false : true;
});

Sorting#

Sort the dataset by label and return self for method chaining:

public sortByLabel(bool $descending = false) : self

Examples

$strata = $dataset->stratify();

$folds = $dataset->stratifiedFold(5);

[$training, $testing] = $dataset->stratifiedSplit(0.8);

Describe by Label#

Describe the features of the dataset broken down by label: Return an array of descriptive statistics about the labels in the dataset:

public describeByLabel() : array

Example

print_r($dataset->describeByLabel());
Array
(
    [not monster] => Array
        (
            [0] => Array
                (
                    [type] => categorical
                    [num_categories] => 1
                    [probabilities] => Array
                        (
                            [nice] => 1
                        )

                )

            [1] => Array
                (
                    [type] => categorical
                    [num_categories] => 2
                    [probabilities] => Array
                        (
                            [furry] => 0.5
                            [rough] => 0.5
                        )

                )

            [2] => Array
                (
                    [type] => categorical
                    [num_categories] => 2
                    [probabilities] => Array
                        (
                            [friendly] => 0.75
                            [loner] => 0.25
                        )

                )

            [3] => Array
                (
                    [type] => continuous
                    [mean] => 1.125
                    [variance] => 12.776875
                    [std_dev] => 3.5744754859979
                    [skewness] => -1.0795676577114
                    [kurtosis] => -0.71758677657925
                    [min] => -5
                    [25%] => 0.7
                    [median] => 2.75
                    [75%] => 3.175
                    [max] => 4
                )

        )

    [monster] => Array
        (
            ...
        )
)

Describe the Labels#

Return an array of descriptive statistics about the labels in the dataset:

public describeLabels() : array

Example

print_r($dataset->describeLabels());
Array
(
    [type] => categorical
    [num_categories] => 2
    [probabilities] => Array
        (
            [monster] => 0.33333333333333
            [not monster] => 0.66666666666667
        )

)

Example#

use Rubix\ML\Datasets\Labeled;

$samples = [
    [0.1, 20, 'furry'],
    [2.0, -5, 'rough'],
    [0.01, 5, 'furry'],
];

$labels = ['not monster', 'monster', 'not monster'];


$dataset = new Labeled($samples, $labels);