R: Get information of an 'lgb.Dataset' object

getinfo {lightgbm} | R Documentation

## Get information of an `lgb.Dataset` object

### Description

Get one attribute of a `lgb.Dataset`

### Usage

    getinfo(dataset, ...)

    ## S3 method for class 'lgb.Dataset'
    getinfo(dataset, name, ...)

### Arguments

`dataset` | Object of class `lgb.Dataset`
`...` | other parameters (ignored)
`name` | the name of the information field to get (see details)

### Details

The `name` field can be one of the following:

- `label`: label lightgbm learn 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

info data

### Examples

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

    labels <- lightgbm::getinfo(dtrain, "label")
    lightgbm::setinfo(dtrain, "label", 1 - labels)

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

[Package lightgbm version 3.3.2 Index]