Added image classifier swift tests

This commit is contained in:
Prianka Liz Kariat 2023-05-26 12:36:35 +05:30
parent f4337356fe
commit d045635c31
2 changed files with 555 additions and 6 deletions

View File

@ -1,4 +1,8 @@
load("@build_bazel_rules_apple//apple:ios.bzl", "ios_unit_test")
load(
"@build_bazel_rules_swift//swift:swift.bzl",
"swift_library",
)
load(
"//mediapipe/framework/tool:ios.bzl",
"MPP_TASK_MINIMUM_OS_VERSION",
@ -24,6 +28,13 @@ TFL_DISABLED_SANITIZER_TAGS = [
"notsan",
]
OPENCV_CONDITIONAL_DEPS = {
"//third_party:opencv_ios_sim_arm64_source_build": ["@ios_opencv_source//:opencv_xcframework"],
"//third_party:opencv_ios_arm64_source_build": ["@ios_opencv_source//:opencv_xcframework"],
"//third_party:opencv_ios_x86_64_source_build": ["@ios_opencv_source//:opencv_xcframework"],
"//conditions:default": ["@ios_opencv//:OpencvFramework"],
}
objc_library(
name = "MPPImageClassifierObjcTestLibrary",
testonly = 1,
@ -41,12 +52,7 @@ objc_library(
"//mediapipe/tasks/ios/common:MPPCommon",
"//mediapipe/tasks/ios/test/vision/utils:MPPImageTestUtils",
"//mediapipe/tasks/ios/vision/image_classifier:MPPImageClassifier",
] + select({
"//third_party:opencv_ios_sim_arm64_source_build": ["@ios_opencv_source//:opencv_xcframework"],
"//third_party:opencv_ios_arm64_source_build": ["@ios_opencv_source//:opencv_xcframework"],
"//third_party:opencv_ios_x86_64_source_build": ["@ios_opencv_source//:opencv_xcframework"],
"//conditions:default": ["@ios_opencv//:OpencvFramework"],
}),
] + select(OPENCV_CONDITIONAL_DEPS),
)
ios_unit_test(
@ -58,3 +64,29 @@ ios_unit_test(
":MPPImageClassifierObjcTestLibrary",
],
)
swift_library(
name = "ImageClassifierSwiftTestLibrary",
testonly = 1,
srcs = ["ImageClassifierTests.swift"],
data = [
"//mediapipe/tasks/testdata/vision:test_images",
"//mediapipe/tasks/testdata/vision:test_models",
],
tags = TFL_DEFAULT_TAGS,
deps = [
"//mediapipe/tasks/ios/common:MPPCommon",
"//mediapipe/tasks/ios/test/vision/utils:MPPImageTestUtils",
"//mediapipe/tasks/ios/vision/image_classifier:MPPImageClassifier",
] + select(OPENCV_CONDITIONAL_DEPS),
)
ios_unit_test(
name = "ImageClassifierSwiftTest",
minimum_os_version = MPP_TASK_MINIMUM_OS_VERSION,
runner = tflite_ios_lab_runner("IOS_LATEST"),
tags = TFL_DEFAULT_TAGS + TFL_DISABLED_SANITIZER_TAGS,
deps = [
":ImageClassifierSwiftTestLibrary",
],
)

View File

@ -0,0 +1,517 @@
// Copyright 2023 The MediaPipe Authors.
//
// Licensed 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.
import MPPCommon
import MPPImageTestUtils
import XCTest
@testable import MPPImageClassifier
typealias FileInfo = (name: String, type: String)
class ImageClassifierTests: XCTestCase, ImageClassifierLiveStreamDelegate {
static let bundle = Bundle(for: ImageClassifierTests.self)
static let floatModelPath = bundle.path(
forResource: "mobilenet_v2_1.0_224",
ofType: "tflite")
static let quantizedModelPath = bundle.path(
forResource: "mobilenet_v1_0.25_224_quant",
ofType: "tflite")
static let burgerImage = FileInfo(name: "burger", type: "jpg")
static let burgerRotatedImage = FileInfo(name: "burger_rotated", type: "jpg")
static let multiObjectsImage = FileInfo(name: "multi_objects", type: "jpg")
static let multiObjectsRotatedImage = FileInfo(name: "multi_objects_rotated", type: "jpg")
static let mobileNetCategoriesCount: Int = 1001;
static let expectedResultsClassifyBurgerImageWithFloatModel = [
ResultCategory(
index: 934,
score: 0.786005,
categoryName: "cheeseburger",
displayName: nil),
ResultCategory(
index: 932,
score: 0.023508,
categoryName: "bagel",
displayName: nil),
ResultCategory(
index: 925,
score: 0.021172,
categoryName: "guacamole",
displayName: nil),
]
func assertEqualErrorDescriptions(
_ error: Error, expectedLocalizedDescription: String
) {
XCTAssertEqual(
error.localizedDescription,
expectedLocalizedDescription)
}
func assertCategoriesAreEqual(
category: ResultCategory,
expectedCategory: ResultCategory,
indexInCategoryList: Int
) {
XCTAssertEqual(
category.index,
expectedCategory.index,
String(
format: """
category[%d].index and expectedCategory[%d].index are not equal.
""", indexInCategoryList))
XCTAssertEqual(
category.score,
expectedCategory.score,
accuracy: 1e-3,
String(
format: """
category[%d].score and expectedCategory[%d].score are not equal.
""", indexInCategoryList))
XCTAssertEqual(
category.categoryName,
expectedCategory.categoryName,
String(
format: """
category[%d].categoryName and expectedCategory[%d].categoryName are \
not equal.
""", indexInCategoryList))
XCTAssertEqual(
category.displayName,
expectedCategory.displayName,
String(
format: """
category[%d].displayName and expectedCategory[%d].displayName are \
not equal.
""", indexInCategoryList))
}
func assertEqualCategoryArrays(
categoryArray: [ResultCategory],
expectedCategoryArray: [ResultCategory]
) {
XCTAssertEqual(
categoryArray.count,
expectedCategoryArray.count)
for (index, (category, expectedCategory)) in
zip(categoryArray, expectedCategoryArray)
.enumerated()
{
assertCategoriesAreEqual(
category: category,
expectedCategory: expectedCategory,
indexInCategoryList: index)
}
}
func assertImageClassifierResultHasOneHead(
_ imageClassifierResult: ImageClassifierResult
) {
XCTAssertEqual(
imageClassifierResult.classificationResult.classifications.count,
1)
XCTAssertEqual(
imageClassifierResult.classificationResult.classifications[0].headIndex,
0)
}
func imageWithFileInfo(_ fileInfo: FileInfo) throws -> MPImage {
let mpImage = try XCTUnwrap(
MPImage.imageFromBundle(
class: type(of: self),
filename: fileInfo.name,
type: fileInfo.type))
return mpImage
}
func imageClassifierOptionsWithModelPath(
_ modelPath: String?
) throws -> ImageClassifierOptions {
let modelPath = try XCTUnwrap(modelPath)
let imageClassifierOptions = ImageClassifierOptions()
imageClassifierOptions.baseOptions.modelAssetPath = modelPath
return imageClassifierOptions
}
func assertCreateImageClassifierThrowsError(
imageClassifierOptions: ImageClassifierOptions,
expectedErrorDescription: String
) {
do {
let imageClassifier = try ImageClassifier(options: imageClassifierOptions)
XCTAssertNil(imageClassifier)
} catch {
assertEqualErrorDescriptions(
error,
expectedLocalizedDescription: expectedErrorDescription)
}
}
func assertImageClassifierResult(
_ imageClassifierResult: ImageClassifierResult,
hasCategoryCount expectedCategoryCount: Int,
andCategories expectedCategories: [ResultCategory]
) throws {
assertImageClassifierResultHasOneHead(imageClassifierResult)
let categories =
imageClassifierResult.classificationResult.classifications[0].categories
XCTAssertEqual(categories.count, expectedCategoryCount)
assertEqualCategoryArrays(
categoryArray:
Array(categories.prefix(expectedCategories.count)),
expectedCategoryArray: expectedCategories)
}
func assertResultsForClassifyImage(
_ image: MPImage,
usingImageClassifier imageClassifier: ImageClassifier,
hasCategoryCount expectedCategoryCount: Int,
andCategories expectedCategories: [ResultCategory]
) throws {
let imageClassifierResult =
try XCTUnwrap(
imageClassifier.classify(image: image))
try assertImageClassifierResult(
imageClassifierResult,
hasCategoryCount: expectedCategoryCount,
andCategories: expectedCategories
)
}
func assertResultsForClassifyImageWithFileInfo(
_ fileInfo: FileInfo,
usingImageClassifier imageClassifier: ImageClassifier,
hasCategoryCount expectedCategoryCount: Int,
andCategories expectedCategories: [ResultCategory]
) throws {
let mpImage = try XCTUnwrap(
imageWithFileInfo(fileInfo))
try assertResultsForClassifyImage(
mpImage,
usingImageClassifier: imageClassifier,
hasCategoryCount: expectedCategoryCount,
andCategories: expectedCategories
)
}
func testCreateImageClassifierWithCategoryAllowlistAndDenylistFails() throws {
let imageClassifierOptions =
try XCTUnwrap(
imageClassifierOptionsWithModelPath(ImageClassifierTests.floatModelPath))
imageClassifierOptions.categoryAllowlist = ["bagel"]
imageClassifierOptions.categoryDenylist = ["guacamole"]
assertCreateImageClassifierThrowsError(
imageClassifierOptions: imageClassifierOptions,
expectedErrorDescription: """
INVALID_ARGUMENT: `category_allowlist` and `category_denylist` are \
mutually exclusive options.
""")
}
func testClassifyWithModelPathAndFloatModelSucceeds() throws {
let modelPath = try XCTUnwrap(ImageClassifierTests.floatModelPath)
let imageClassifier = try XCTUnwrap(ImageClassifier(modelPath: modelPath))
try assertResultsForClassifyImageWithFileInfo(
ImageClassifierTests.burgerImage,
usingImageClassifier: imageClassifier,
hasCategoryCount: ImageClassifierTests.mobileNetCategoriesCount,
andCategories: ImageClassifierTests.expectedResultsClassifyBurgerImageWithFloatModel)
}
func testClassifyWithOptionsAndFloatModelSucceeds() throws {
let imageClassifierOptions =
try XCTUnwrap(
imageClassifierOptionsWithModelPath(ImageClassifierTests.floatModelPath))
let imageClassifier = try XCTUnwrap(ImageClassifier(options: imageClassifierOptions))
try assertResultsForClassifyImageWithFileInfo(
ImageClassifierTests.burgerImage,
usingImageClassifier: imageClassifier,
hasCategoryCount: ImageClassifierTests.mobileNetCategoriesCount,
andCategories:
ImageClassifierTests.expectedResultsClassifyBurgerImageWithFloatModel)
}
func testClassifyWithQuantizedModelSucceeds() throws {
let imageClassifierOptions =
try XCTUnwrap(
imageClassifierOptionsWithModelPath(
ImageClassifierTests.quantizedModelPath))
let imageClassifier = try XCTUnwrap(ImageClassifier(options: imageClassifierOptions))
let expectedCategories = [
ResultCategory(
index: 934,
score: 0.972656,
categoryName: "cheeseburger",
displayName: nil),
]
try assertResultsForClassifyImageWithFileInfo(
ImageClassifierTests.burgerImage,
usingImageClassifier: imageClassifier,
hasCategoryCount: ImageClassifierTests.mobileNetCategoriesCount,
andCategories: expectedCategories)
}
func testClassifyWithScoreThresholdSucceeds() throws {
let imageClassifierOptions =
try XCTUnwrap(
imageClassifierOptionsWithModelPath(ImageClassifierTests.floatModelPath))
imageClassifierOptions.scoreThreshold = 0.25
let imageClassifier = try XCTUnwrap(ImageClassifier(
options: imageClassifierOptions))
let expectedCategories = [
ResultCategory(
index: 934,
score: 0.786005,
categoryName: "cheeseburger",
displayName: nil),
]
try assertResultsForClassifyImageWithFileInfo(
ImageClassifierTests.burgerImage,
usingImageClassifier: imageClassifier,
hasCategoryCount: expectedCategories.count,
andCategories: expectedCategories)
}
func testClassifyWithAllowlistSucceeds() throws {
let imageClassifierOptions =
try XCTUnwrap(
imageClassifierOptionsWithModelPath(ImageClassifierTests.floatModelPath))
imageClassifierOptions.categoryAllowlist =
["cheeseburger", "guacamole", "meat loaf"]
let imageClassifier = try XCTUnwrap(ImageClassifier(
options: imageClassifierOptions))
let expectedCategories = [
ResultCategory(
index: 934,
score: 0.786005,
categoryName: "cheeseburger",
displayName: nil),
ResultCategory(
index: 925,
score: 0.021172,
categoryName: "guacamole",
displayName: nil),
ResultCategory(
index: 963,
score: 0.006279315,
categoryName: "meat loaf",
displayName: nil),
]
try assertResultsForClassifyImageWithFileInfo(
ImageClassifierTests.burgerImage,
usingImageClassifier: imageClassifier,
hasCategoryCount: expectedCategories.count,
andCategories: expectedCategories)
}
func testClassifyWithDenylistSucceeds() throws {
let imageClassifierOptions =
try XCTUnwrap(
imageClassifierOptionsWithModelPath(
ImageClassifierTests.floatModelPath))
imageClassifierOptions.categoryDenylist = ["bagel"]
let maxResults = 3;
imageClassifierOptions.maxResults = maxResults;
let imageClassifier = try XCTUnwrap(ImageClassifier(
options: imageClassifierOptions))
let expectedCategories = [
ResultCategory(
index: 934,
score: 0.786005,
categoryName: "cheeseburger",
displayName: nil),
ResultCategory(
index: 925,
score: 0.021172,
categoryName: "guacamole",
displayName: nil),
ResultCategory(
index: 963,
score: 0.006279315,
categoryName: "meat loaf",
displayName: nil),
]
try assertResultsForClassifyImageWithFileInfo(
ImageClassifierTests.burgerImage,
usingImageClassifier: imageClassifier,
hasCategoryCount: maxResults,
andCategories: expectedCategories)
}
func testClassifyWithRegionOfInterestSucceeds() throws {
let imageClassifierOptions =
try XCTUnwrap(
imageClassifierOptionsWithModelPath(
ImageClassifierTests.floatModelPath))
let maxResults = 1;
imageClassifierOptions.maxResults = maxResults;
let imageClassifier = try XCTUnwrap(ImageClassifier(
options: imageClassifierOptions))
let mpImage = try XCTUnwrap(
imageWithFileInfo(ImageClassifierTests.multiObjectsImage))
let imageClassifierResult = try XCTUnwrap(
imageClassifier.classify(
image: mpImage,
regionOfInterest: CGRect(
x: 0.450,
y: 0.308,
width: 0.164,
height: 0.426)))
let expectedCategories = [
ResultCategory(
index: 806,
score: 0.997122,
categoryName: "soccer ball",
displayName: nil),
]
try assertImageClassifierResult(
imageClassifierResult,
hasCategoryCount: maxResults,
andCategories: expectedCategories)
}
func testClassifyWithOrientationSucceeds() throws {
let imageClassifierOptions =
try XCTUnwrap(
imageClassifierOptionsWithModelPath(
ImageClassifierTests.floatModelPath))
let maxResults = 3;
imageClassifierOptions.maxResults = maxResults;
let imageClassifier = try XCTUnwrap(ImageClassifier(
options: imageClassifierOptions))
let expectedCategories = [
ResultCategory(
index: 934,
score: 0.753852,
categoryName: "cheeseburger",
displayName: nil),
ResultCategory(
index: 925,
score: 0.028609,
categoryName: "guacamole",
displayName: nil),
ResultCategory(
index: 932,
score: 0.027782,
categoryName: "bagel",
displayName: nil),
]
let mpImage = try XCTUnwrap(
MPImage.imageFromBundle(
class: type(of: self),
filename: ImageClassifierTests.burgerRotatedImage.name,
type: ImageClassifierTests.burgerRotatedImage.type,
orientation: .right))
try assertResultsForClassifyImage(
mpImage,
usingImageClassifier: imageClassifier,
hasCategoryCount: expectedCategories.count,
andCategories: expectedCategories)
}
func testClassifyWithOrientationAndRegionOfInterestSucceeds() throws {
let imageClassifierOptions =
try XCTUnwrap(
imageClassifierOptionsWithModelPath(
ImageClassifierTests.floatModelPath))
let maxResults = 3;
imageClassifierOptions.maxResults = maxResults;
let imageClassifier = try XCTUnwrap(ImageClassifier(
options: imageClassifierOptions))
let expectedCategories = [
ResultCategory(
index: 560,
score: 0.604605,
categoryName: "folding chair",
displayName: nil),
]
let mpImage = try XCTUnwrap(
MPImage.imageFromBundle(
class: type(of: self),
filename: ImageClassifierTests.multiObjectsRotatedImage.name,
type: ImageClassifierTests.multiObjectsRotatedImage.type,
orientation: .right))
let imageClassifierResult = try XCTUnwrap(
imageClassifier.classify(
image: mpImage,
regionOfInterest: CGRect(
x: 0.0,
y: 0.1763,
width: 0.5642,
height: 0.1286)))
try assertImageClassifierResult(
imageClassifierResult,
hasCategoryCount: maxResults,
andCategories: expectedCategories)
}
}