[doc] update doc for dumping model to be json or ubj for jvm packages (#7955)
This commit is contained in:
parent
80339c3427
commit
5a7dc41351
@ -345,6 +345,16 @@ and then loading the model in another session:
|
||||
val xgbClassificationModel2 = XGBoostClassificationModel.load(xgbClassificationModelPath)
|
||||
xgbClassificationModel2.transform(xgbInput)
|
||||
|
||||
.. note::
|
||||
|
||||
Besides dumping the model to raw format, users are able to dump the model to be json or ubj format from ``version 2.0.0+``.
|
||||
|
||||
.. code-block:: scala
|
||||
|
||||
val xgbClassificationModelPath = "/tmp/xgbClassificationModel"
|
||||
xgbClassificationModel.write.overwrite().option("format", "json").save(xgbClassificationModelPath)
|
||||
|
||||
|
||||
With regards to ML pipeline save and load, please refer the next section.
|
||||
|
||||
Interact with Other Bindings of XGBoost
|
||||
|
||||
@ -44,6 +44,7 @@ with normal model IO operation. Currently, memory snapshot is used in the follow
|
||||
* Python package: when the ``Booster`` object is pickled with the built-in ``pickle`` module.
|
||||
* R package: when the ``xgb.Booster`` object is persisted with the built-in functions ``saveRDS``
|
||||
or ``save``.
|
||||
* JVM packages: when the ``Booster`` object is serialized with the built-in functions ``saveModel``.
|
||||
|
||||
Other language bindings are still working in progress.
|
||||
|
||||
@ -68,6 +69,12 @@ a filename with ``.json`` or ``.ubj`` as file extension, the latter is the exten
|
||||
|
||||
xgb.save(bst, 'model_file_name.json')
|
||||
|
||||
.. code-block:: Scala
|
||||
:caption: Scala
|
||||
|
||||
val format = "json" // or val format = "ubj"
|
||||
model.write.option("format", format).save("model_directory_path")
|
||||
|
||||
.. note::
|
||||
|
||||
Only load models from JSON files that were produced by XGBoost. Attempting to load
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user