R: Get one attribute of a 'lgb.Dataset'

get_field {lightgbm} | R Documentation

## Get one attribute of a `lgb.Dataset`

### Description

Get one attribute of a `lgb.Dataset`

### Usage

    get_field(dataset, field_name)

    ## S3 method for class 'lgb.Dataset'
    get_field(dataset, field_name)

### Arguments

`dataset` | Object of class `lgb.Dataset`
`field_name` | String with the name of the attribute to get. One of the following. `label`: label lightgbm learns from ; `weight`: to do a weight rescale ; `group`: used for learning-to-rank tasks. An integer vector describing how to group rows together as ordered results from the same set of candidate results to be ranked. For example, if you have a 100-document dataset with `group = c(10, 20, 40, 10, 10, 10)`, that means that you have 6 groups, where the first 10 records are in the first group, records 11-30 are in the second group, etc. `init_score`: initial score is the base prediction lightgbm will boost from.

### Value

requested attribute

### Examples

    data(agaricus.train, package = "lightgbm")
    train <- agaricus.train
    dtrain <- lgb.Dataset(train$data, label = train$label)
    lgb.Dataset.construct(dtrain)

    labels <- lightgbm::get_field(dtrain, "label")
    lightgbm::set_field(dtrain, "label", 1 - labels)

    labels2 <- lightgbm::get_field(dtrain, "label")
    stopifnot(all(labels2 == 1 - labels))

[Package lightgbm version 3.3.2 Index]