[backport] [doc] Add missing document for pyspark ranker. (#8692) (#8990)

This commit is contained in:
Jiaming Yuan 2023-03-29 12:02:51 +08:00 committed by GitHub
parent f5f03dfb61
commit 365da0b8f4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 21 additions and 10 deletions

View File

@ -173,3 +173,13 @@ PySpark API
:members: :members:
:inherited-members: :inherited-members:
:show-inheritance: :show-inheritance:
.. autoclass:: xgboost.spark.SparkXGBRanker
:members:
:inherited-members:
:show-inheritance:
.. autoclass:: xgboost.spark.SparkXGBRankerModel
:members:
:inherited-members:
:show-inheritance:

View File

@ -43,10 +43,10 @@ in spark estimator, and some parameters are replaced with pyspark specific param
such as `weight_col`, `validation_indicator_col`, `use_gpu`, for details please see such as `weight_col`, `validation_indicator_col`, `use_gpu`, for details please see
`SparkXGBRegressor` doc. `SparkXGBRegressor` doc.
The following code snippet shows how to train a spark xgboost regressor model, The following code snippet shows how to train a spark xgboost regressor model, first we
first we need to prepare a training dataset as a spark dataframe contains need to prepare a training dataset as a spark dataframe contains "label" column and
"label" column and "features" column(s), the "features" column(s) must be `pyspark.ml.linalg.Vector` "features" column(s), the "features" column(s) must be ``pyspark.ml.linalg.Vector`` type
type or spark array type or a list of feature column names. or spark array type or a list of feature column names.
.. code-block:: python .. code-block:: python
@ -54,10 +54,10 @@ type or spark array type or a list of feature column names.
xgb_regressor_model = xgb_regressor.fit(train_spark_dataframe) xgb_regressor_model = xgb_regressor.fit(train_spark_dataframe)
The following code snippet shows how to predict test data using a spark xgboost regressor model, The following code snippet shows how to predict test data using a spark xgboost regressor
first we need to prepare a test dataset as a spark dataframe contains model, first we need to prepare a test dataset as a spark dataframe contains "features"
"features" and "label" column, the "features" column must be `pyspark.ml.linalg.Vector` and "label" column, the "features" column must be ``pyspark.ml.linalg.Vector`` type or
type or spark array type. spark array type.
.. code-block:: python .. code-block:: python

View File

@ -1,6 +1,5 @@
# type: ignore # type: ignore
"""PySpark XGBoost integration interface """PySpark XGBoost integration interface"""
"""
try: try:
import pyspark import pyspark
@ -11,6 +10,7 @@ from .estimator import (
SparkXGBClassifier, SparkXGBClassifier,
SparkXGBClassifierModel, SparkXGBClassifierModel,
SparkXGBRanker, SparkXGBRanker,
SparkXGBRankerModel,
SparkXGBRegressor, SparkXGBRegressor,
SparkXGBRegressorModel, SparkXGBRegressorModel,
) )
@ -21,4 +21,5 @@ __all__ = [
"SparkXGBRegressor", "SparkXGBRegressor",
"SparkXGBRegressorModel", "SparkXGBRegressorModel",
"SparkXGBRanker", "SparkXGBRanker",
"SparkXGBRankerModel",
] ]