Using `XGBoost` on Heroku

README.md

Using XGBoost on Heroku

Replication project for #26 xgboost not installing issue on GitHub, for using the XGBoost package in R on Heroku.

Using Heroku's container stack, together with the heroku-docker-r image.

Usage

• Build

  make build
  

• Test

  make run
  

• Deploy

  heroku create --stack=container
  git push heroku main
  

Credits

Sample code from XGBoost documentation.

License

MIT License. Copyright (c) 2022 Chris Stefano. See LICENSE for details.

app.R

#
# Example R program
#

# https://xgboost.readthedocs.io/en/stable/R-package/xgboostPresentation.html

require(xgboost)

data(agaricus.train, package='xgboost')
data(agaricus.test, package='xgboost')
train <- agaricus.train
test <- agaricus.test

str(train)
dim(train$data)
dim(test$data)
class(train$data)[1]
class(train$label)

Dockerfile

FROM virtualstaticvoid/heroku-docker-r:build
CMD ["/usr/bin/R", "--no-save", "-f", "/app/app.R"]

heroku.yml

build:
  docker:
    app: Dockerfile

init.R

# install additional packages, using helper function
helpers.installPackages("xgboost")

LICENSE

The MIT License (MIT)

Copyright (c) 2022 Chris Stefano <virtualstaticvoid@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Makefile

.PHONY: all build run

# default build target
all::

all:: build

APP ?= $(shell basename $(PWD))

build:

	docker build --tag heroku-docker-r-example:$(APP) .

run:

	docker run -it --rm heroku-docker-r-example:$(APP)