Skip to content

[SPARK-25345][ML] Deprecate public APIs from ImageSchema #22349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
WeichenXu123 wants to merge 5 commits into from
Closed

[SPARK-25345][ML] Deprecate public APIs from ImageSchema #22349

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2397321
init pr
WeichenXu123 Sep 6, 2018
38c33da
update
WeichenXu123 Sep 6, 2018
f5a13a5
only deprecate readImage method
WeichenXu123 Sep 7, 2018
5cefd23
add py warning
WeichenXu123 Sep 8, 2018
576b7d8
address comments
WeichenXu123 Sep 8, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions mllib/src/main/scala/org/apache/spark/ml/image/ImageSchema.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,8 @@ object ImageSchema {
* @return DataFrame with a single column "image" of images;
* see ImageSchema for the details
*/
@deprecated("use `spark.read.format(\"image\").load(path)` and this `readImages` will be " +
"removed in 3.0.0.", "2.4.0")
def readImages(path: String): DataFrame = readImages(path, null, false, -1, false, 1.0, 0)

/**
Expand All @@ -218,6 +220,8 @@ object ImageSchema {
* @return DataFrame with a single column "image" of images;
* see ImageSchema for the details
*/
@deprecated("use `spark.read.format(\"image\").load(path)` and this `readImages` will be " +
"removed in 3.0.0.", "2.4.0")
def readImages(
path: String,
sparkSession: SparkSession,
Expand Down
7 changes: 6 additions & 1 deletion python/pyspark/ml/image.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
from pyspark import SparkContext
from pyspark.sql.types import Row, _create_row, _parse_datatype_json_string
from pyspark.sql import DataFrame, SparkSession
import warnings

@HyukjinKwon HyukjinKwon Sep 8, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically builtin package should be ordered above per PEP 8. I wonder why this is not caught.

import sys
import warnings
 
import numpy as np

from pyspark import SparkContext
from pyspark.sql.types import Row, _create_row, _parse_datatype_json_string
from pyspark.sql import DataFrame, SparkSession


__all__ = ["ImageSchema"]

Expand Down Expand Up @@ -207,6 +208,9 @@ def readImages(self, path, recursive=False, numPartitions=-1,
.. note:: If sample ratio is less than 1, sampling uses a PathFilter that is efficient but
potentially non-deterministic.

.. note:: Deprecated in 2.4.0. Use `spark.read.format("image").load(path)` instead and

@holdenk holdenk Sep 7, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it make sense to issue a warning when people call this code path (e.g. warnings.warn)? We do it in some of the other Python deprecated APIs but not all.

@WeichenXu123 WeichenXu123 Sep 8, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added.

this `readImages` will be removed in 3.0.0.

:param str path: Path to the image directory.
:param bool recursive: Recursive search flag.
:param int numPartitions: Number of DataFrame partitions.
Expand All @@ -222,7 +226,8 @@ def readImages(self, path, recursive=False, numPartitions=-1,

.. versionadded:: 2.3.0
"""

warnings.warn("`ImageSchema.readImage` is deprecated. " +
"Use `spark.read.format(\"image\").load(path)` instead.")

@HyukjinKwon HyukjinKwon Sep 8, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

warnings.warn(..., DeprecationWarning)

spark = SparkSession.builder.getOrCreate()
image_schema = spark._jvm.org.apache.spark.ml.image.ImageSchema
jsession = spark._jsparkSession
Expand Down