lgb.Dataset.Rd 1.28 KB
Newer Older
Guolin Ke's avatar
Guolin Ke committed
1
2
3
4
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/lgb.Dataset.R
\name{lgb.Dataset}
\alias{lgb.Dataset}
Nikita Titov's avatar
Nikita Titov committed
5
\title{Construct \code{lgb.Dataset} object}
Guolin Ke's avatar
Guolin Ke committed
6
\usage{
7
8
9
10
11
12
13
14
15
16
lgb.Dataset(
  data,
  params = list(),
  reference = NULL,
  colnames = NULL,
  categorical_feature = NULL,
  free_raw_data = TRUE,
  info = list(),
  ...
)
Guolin Ke's avatar
Guolin Ke committed
17
18
19
20
21
22
23
24
25
26
27
28
29
30
}
\arguments{
\item{data}{a \code{matrix} object, a \code{dgCMatrix} object or a character representing a filename}

\item{params}{a list of parameters}

\item{reference}{reference dataset}

\item{colnames}{names of columns}

\item{categorical_feature}{categorical features}

\item{free_raw_data}{TRUE for need to free raw data after construct}

Nikita Titov's avatar
Nikita Titov committed
31
\item{info}{a list of information of the \code{lgb.Dataset} object}
Guolin Ke's avatar
Guolin Ke committed
32
33
34
35
36
37
38

\item{...}{other information to pass to \code{info} or parameters pass to \code{params}}
}
\value{
constructed dataset
}
\description{
Nikita Titov's avatar
Nikita Titov committed
39
Construct \code{lgb.Dataset} object from dense matrix, sparse matrix
Guolin Ke's avatar
Guolin Ke committed
40
41
42
43
44
45
46
47
48
49
50
51
or local file (that was created previously by saving an \code{lgb.Dataset}).
}
\examples{
library(lightgbm)
data(agaricus.train, package = "lightgbm")
train <- agaricus.train
dtrain <- lgb.Dataset(train$data, label = train$label)
lgb.Dataset.save(dtrain, "lgb.Dataset.data")
dtrain <- lgb.Dataset("lgb.Dataset.data")
lgb.Dataset.construct(dtrain)

}