forked from combust/mleap
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding documentation and RELEASE NOTES
- Loading branch information
1 parent
2887ebc
commit a5c6de1
Showing
2 changed files
with
24 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# MLeap XGBoost Runtime | ||
|
||
We provide two implementation of XGboost for use at runtime: | ||
- XGboost4j (from `ml.dmlc.xgboost4j`): this is the official C++ implementation. | ||
- XGBoost-Predictor (from `biz.k11i.xgboost-predictor`): this is a much faster implementation written directly in Java. | ||
|
||
By default, MLeap Bundles are de-serialized into XGboost4j Booster objects. | ||
In order to use the Predictor implementation, you may: | ||
|
||
1. Create a `resources/reference.conf` file in your project, like this: | ||
``` | ||
ml.combust.mleap.xgboost.ops = [ | ||
"ml.combust.mleap.xgboost.runtime.bundle.ops.XGBoostPredictorClassificationOp", | ||
"ml.combust.mleap.xgboost.runtime.bundle.ops.XGBoostRegressionOp" | ||
] | ||
``` | ||
2. add this to your project's pom file: | ||
``` | ||
<!-- Append our reference.conf into MLeap's reference.conf so our Ops are registered --> | ||
<transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer"> | ||
<resource>reference.conf</resource> | ||
</transformer> | ||
``` |