31a16fbb40
### What changes were proposed in this pull request? This PR proposes migration of [`pyspark-stubs`](https://github.com/zero323/pyspark-stubs) into Spark codebase. ### Why are the changes needed? ### Does this PR introduce _any_ user-facing change? Yes. This PR adds type annotations directly to Spark source. This can impact interaction with development tools for users, which haven't used `pyspark-stubs`. ### How was this patch tested? - [x] MyPy tests of the PySpark source ``` mypy --no-incremental --config python/mypy.ini python/pyspark ``` - [x] MyPy tests of Spark examples ``` MYPYPATH=python/ mypy --no-incremental --config python/mypy.ini examples/src/main/python/ml examples/src/main/python/sql examples/src/main/python/sql/streaming ``` - [x] Existing Flake8 linter - [x] Existing unit tests Tested against: - `mypy==0.790+dev.e959952d9001e9713d329a2f9b196705b028f894` - `mypy==0.782` Closes #29591 from zero323/SPARK-32681. Authored-by: zero323 <mszymkiewicz@gmail.com> Signed-off-by: HyukjinKwon <gurwls223@apache.org>
153 lines
5.4 KiB
Python
153 lines
5.4 KiB
Python
#
|
|
# Licensed to the Apache Software Foundation (ASF) under one
|
|
# or more contributor license agreements. See the NOTICE file
|
|
# distributed with this work for additional information
|
|
# regarding copyright ownership. The ASF licenses this file
|
|
# to you under the Apache License, Version 2.0 (the
|
|
# "License"); you may not use this file except in compliance
|
|
# with the License. You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing,
|
|
# software distributed under the License is distributed on an
|
|
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
# KIND, either express or implied. See the License for the
|
|
# specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
from typing import Any, Optional
|
|
|
|
import sys # noqa: F401
|
|
|
|
from pyspark import since, keyword_only # noqa: F401
|
|
from pyspark.ml.param.shared import (
|
|
HasBlockSize,
|
|
HasCheckpointInterval,
|
|
HasMaxIter,
|
|
HasPredictionCol,
|
|
HasRegParam,
|
|
HasSeed,
|
|
)
|
|
from pyspark.ml.wrapper import JavaEstimator, JavaModel
|
|
from pyspark.ml.common import inherit_doc # noqa: F401
|
|
from pyspark.ml.param import Param
|
|
from pyspark.ml.util import JavaMLWritable, JavaMLReadable
|
|
|
|
from pyspark.sql.dataframe import DataFrame
|
|
|
|
class _ALSModelParams(HasPredictionCol, HasBlockSize):
|
|
userCol: Param[str]
|
|
itemCol: Param[str]
|
|
coldStartStrategy: Param[str]
|
|
def getUserCol(self) -> str: ...
|
|
def getItemCol(self) -> str: ...
|
|
def getColdStartStrategy(self) -> str: ...
|
|
|
|
class _ALSParams(
|
|
_ALSModelParams, HasMaxIter, HasRegParam, HasCheckpointInterval, HasSeed
|
|
):
|
|
rank: Param[int]
|
|
numUserBlocks: Param[int]
|
|
numItemBlocks: Param[int]
|
|
implicitPrefs: Param[bool]
|
|
alpha: Param[float]
|
|
ratingCol: Param[str]
|
|
nonnegative: Param[bool]
|
|
intermediateStorageLevel: Param[str]
|
|
finalStorageLevel: Param[str]
|
|
def __init__(self, *args: Any): ...
|
|
def getRank(self) -> int: ...
|
|
def getNumUserBlocks(self) -> int: ...
|
|
def getNumItemBlocks(self) -> int: ...
|
|
def getImplicitPrefs(self) -> bool: ...
|
|
def getAlpha(self) -> float: ...
|
|
def getRatingCol(self) -> str: ...
|
|
def getNonnegative(self) -> bool: ...
|
|
def getIntermediateStorageLevel(self) -> str: ...
|
|
def getFinalStorageLevel(self) -> str: ...
|
|
|
|
class ALS(JavaEstimator[ALSModel], _ALSParams, JavaMLWritable, JavaMLReadable[ALS]):
|
|
def __init__(
|
|
self,
|
|
*,
|
|
rank: int = ...,
|
|
maxIter: int = ...,
|
|
regParam: float = ...,
|
|
numUserBlocks: int = ...,
|
|
numItemBlocks: int = ...,
|
|
implicitPrefs: bool = ...,
|
|
alpha: float = ...,
|
|
userCol: str = ...,
|
|
itemCol: str = ...,
|
|
seed: Optional[int] = ...,
|
|
ratingCol: str = ...,
|
|
nonnegative: bool = ...,
|
|
checkpointInterval: int = ...,
|
|
intermediateStorageLevel: str = ...,
|
|
finalStorageLevel: str = ...,
|
|
coldStartStrategy: str = ...,
|
|
blockSize: int = ...
|
|
) -> None: ...
|
|
def setParams(
|
|
self,
|
|
*,
|
|
rank: int = ...,
|
|
maxIter: int = ...,
|
|
regParam: float = ...,
|
|
numUserBlocks: int = ...,
|
|
numItemBlocks: int = ...,
|
|
implicitPrefs: bool = ...,
|
|
alpha: float = ...,
|
|
userCol: str = ...,
|
|
itemCol: str = ...,
|
|
seed: Optional[int] = ...,
|
|
ratingCol: str = ...,
|
|
nonnegative: bool = ...,
|
|
checkpointInterval: int = ...,
|
|
intermediateStorageLevel: str = ...,
|
|
finalStorageLevel: str = ...,
|
|
coldStartStrategy: str = ...,
|
|
blockSize: int = ...
|
|
) -> ALS: ...
|
|
def setRank(self, value: int) -> ALS: ...
|
|
def setNumUserBlocks(self, value: int) -> ALS: ...
|
|
def setNumItemBlocks(self, value: int) -> ALS: ...
|
|
def setNumBlocks(self, value: int) -> ALS: ...
|
|
def setImplicitPrefs(self, value: bool) -> ALS: ...
|
|
def setAlpha(self, value: float) -> ALS: ...
|
|
def setUserCol(self, value: str) -> ALS: ...
|
|
def setItemCol(self, value: str) -> ALS: ...
|
|
def setRatingCol(self, value: str) -> ALS: ...
|
|
def setNonnegative(self, value: bool) -> ALS: ...
|
|
def setIntermediateStorageLevel(self, value: str) -> ALS: ...
|
|
def setFinalStorageLevel(self, value: str) -> ALS: ...
|
|
def setColdStartStrategy(self, value: str) -> ALS: ...
|
|
def setMaxIter(self, value: int) -> ALS: ...
|
|
def setRegParam(self, value: float) -> ALS: ...
|
|
def setPredictionCol(self, value: str) -> ALS: ...
|
|
def setCheckpointInterval(self, value: int) -> ALS: ...
|
|
def setSeed(self, value: int) -> ALS: ...
|
|
def setBlockSize(self, value: int) -> ALS: ...
|
|
|
|
class ALSModel(JavaModel, _ALSModelParams, JavaMLWritable, JavaMLReadable[ALSModel]):
|
|
def setUserCol(self, value: str) -> ALSModel: ...
|
|
def setItemCol(self, value: str) -> ALSModel: ...
|
|
def setColdStartStrategy(self, value: str) -> ALSModel: ...
|
|
def setPredictionCol(self, value: str) -> ALSModel: ...
|
|
def setBlockSize(self, value: int) -> ALSModel: ...
|
|
@property
|
|
def rank(self) -> int: ...
|
|
@property
|
|
def userFactors(self) -> DataFrame: ...
|
|
@property
|
|
def itemFactors(self) -> DataFrame: ...
|
|
def recommendForAllUsers(self, numItems: int) -> DataFrame: ...
|
|
def recommendForAllItems(self, numUsers: int) -> DataFrame: ...
|
|
def recommendForUserSubset(
|
|
self, dataset: DataFrame, numItems: int
|
|
) -> DataFrame: ...
|
|
def recommendForItemSubset(
|
|
self, dataset: DataFrame, numUsers: int
|
|
) -> DataFrame: ...
|