Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[R-package] [docs] Added documentation on lgb.dl() and data.table version (fixes #2715) #2846

Merged
merged 4 commits into from
Mar 4, 2020
Merged

[R-package] [docs] Added documentation on lgb.dl() and data.table version (fixes #2715) #2846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a9936b3
[R-package] [docs] Added documentation on lgb.dl() and data.table ver…
jameslamb Feb 29, 2020
ca1aaf1
added missed table of contents item
jameslamb Feb 29, 2020
6f6a937
moved known issues to FAQ docs
jameslamb Mar 4, 2020
d9c37d2
fixed formatting
jameslamb Mar 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions R-package/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
LightGBM R-package
==================

### Contents

* [Installation](#installation)
* [Examples](#examples)
* [Testing](#testing)
* [External Repositories](#external-unofficial-repositories)
* [Known Issues](#known-issues)

Installation
------------

Expand Down Expand Up @@ -156,3 +164,8 @@ External (Unofficial) Repositories
Projects listed here are not maintained or endorsed by the `LightGBM` development team, but may offer some features currently missing from the main R package.

* [lightgbm.py](https://github.com/kapsner/lightgbm.py): This R package offers a wrapper built with `reticulate`, a package used to call Python code from R. If you are comfortable with the added installation complexity of installing `lightgbm`'s Python package and the performance cost of passing data between R and Python, you might find that this package offers some features that are not yet available in the native `lightgbm` R package.

Known Issues
------------

For information about known issues with the R package, see the [R-package section of LightGBM's main FAQ page](https://lightgbm.readthedocs.io/en/latest/FAQ.html#r-package).
9 changes: 7 additions & 2 deletions docs/FAQ.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,12 +201,17 @@ Run ``lgb.unloader(wipe = TRUE)`` in the R console, and recreate the LightGBM da
Due to the pointers, choosing to not wipe variables will not fix the error.
This is a known issue: `Microsoft/LightGBM#698 <https://github.com/microsoft/LightGBM/issues/698>`__.

2. I used ``setinfo``, tried to print my ``lgb.Dataset``, and now the R console froze!
--------------------------------------------------------------------------------------
2. I used ``setinfo()``, tried to print my ``lgb.Dataset``, and now the R console froze!
----------------------------------------------------------------------------------------

Avoid printing the ``lgb.Dataset`` after using ``setinfo``.
This is a known bug: `Microsoft/LightGBM#539 <https://github.com/microsoft/LightGBM/issues/539>`__.

3. ``error in data.table::data.table()...argument 2 is NULL``
-------------------------------------------------------------

If you experiencing this error when running `lightgbm`, you may be facing the same issue reported in `#2715 <https://github.com/microsoft/LightGBM/issues/2715>`_. If you use ``lgb.dl()`` to build from source (i.e. not using pre-compiled dll), you need to upgrade your version of ``data.table`` to at least version 1.12.0.

------

Python-package
Expand Down