[doc] Integrate pyspark module into sphinx doc [skip ci] (#8066)

This commit is contained in:
Jiaming Yuan
2022-07-17 10:46:09 +08:00
committed by GitHub
parent 579ab23b10
commit e28f6f6657
4 changed files with 47 additions and 13 deletions

View File

@@ -207,10 +207,11 @@ intersphinx_mapping = {
"python": ("https://docs.python.org/3.6", None),
"numpy": ("https://docs.scipy.org/doc/numpy/", None),
"scipy": ("https://docs.scipy.org/doc/scipy/reference/", None),
"pandas": ("http://pandas-docs.github.io/pandas-docs-travis/", None),
"pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None),
"sklearn": ("https://scikit-learn.org/stable", None),
"dask": ("https://docs.dask.org/en/stable/", None),
"distributed": ("https://distributed.dask.org/en/stable/", None),
"pyspark": ("https://spark.apache.org/docs/latest/api/python/", None),
}

View File

@@ -147,3 +147,29 @@ Dask API
:members:
:inherited-members:
:show-inheritance:
PySpark API
-----------
.. automodule:: xgboost.spark
.. autoclass:: xgboost.spark.SparkXGBClassifier
:members:
:inherited-members:
:show-inheritance:
.. autoclass:: xgboost.spark.SparkXGBClassifierModel
:members:
:inherited-members:
:show-inheritance:
.. autoclass:: xgboost.spark.SparkXGBRegressor
:members:
:inherited-members:
:show-inheritance:
.. autoclass:: xgboost.spark.SparkXGBRegressorModel
:members:
:inherited-members:
:show-inheritance:

View File

@@ -9,4 +9,6 @@ graphviz
numpy
recommonmark
xgboost_ray
sphinx-gallery
sphinx-gallery
pyspark
cloudpickle