Image Recognition. SDK Reference. Issue 09 Date HUAWEI TECHNOLOGIES CO., LTD.

Transcription

1 Issue 09 Date HUAWEI TECHNOLOGIES CO., LTD.

2 Copyright Huawei Technologies Co., Ltd All rights reserved. No part of this document may be reproduced or transmitted in any form or by any means without prior written consent of Huawei Technologies Co., Ltd. Trademarks and Permissions and other Huawei trademarks are trademarks of Huawei Technologies Co., Ltd. All other trademarks and trade names mentioned in this document are the property of their respective holders. Notice The purchased products, services and features are stipulated by the contract made between Huawei and the customer. All or part of the products, services and features described in this document may not be within the purchase scope or the usage scope. Unless otherwise specified in the contract, all statements, information, and recommendations in this document are provided "AS IS" without warranties, guarantees or representations of any kind, either express or implied. The information in this document is subject to change without notice. Every effort has been made in the preparation of this document to ensure accuracy of the contents, but all statements, information, and recommendations in this document do not constitute a warranty of any kind, express or implied. Huawei Technologies Co., Ltd. Address: Website: Huawei Industrial Base Bantian, Longgang Shenzhen People's Republic of China support@huawei.com Issue 09 ( ) Copyright Huawei Technologies Co., Ltd. i

3 Contents Contents 1 Introduction to Image SDK Applying for a Service Obtaining Authentication Information Obtaining Image SDK Preparing the Environment Preparing a Java Development Environment Installing Eclipse and Importing SDK Projects Demo Project of Image Tagging Demo Project of Celebrity Recognition Demo Project of Recapture Detection Demo Project of Dark Enhance Demo Project of Defog Demo Project of Super Resolution Demo Project of BMR SDK Project Using Token Authentication...13 A Appendix...15 A.1 Change History Issue 09 ( ) Copyright Huawei Technologies Co., Ltd. ii

4 1 Introduction to Image SDK 1 Introduction to Image SDK Overview of SDK Overview uses computers to process, analyze, and understand images to recognize objects of different forms. It also enhances and reconstructs poor-quality images. provides services through open application programming interfaces (APIs). You can obtain the inference results by accessing and calling APIs in real time. It helps you collect key data automatically and build an intelligent service system, thereby improving service efficiency. Software Development Kit (Image SDK for short) encapsulates the RESTful APIs provided by to simplify application development. You can directly call API functions provided by Image SDK to use. Mappings Between Services and APIs Table 1-1 lists the mappings between the sub-services and APIs. Table 1-1 Mappings between services and APIs Service Image Tagging Celebrity Recognition Recapture Detection Dark Enhance Defog Super Resolution API POST /v1.0/image/tagging POST /v1.0/image/celebrity-recognition POST /v1.0/image/recapture-detect POST /v1.0/vision/dark-enhance POST /v1.0/vision/defog POST /v1.0/vision/super-resolution Issue 09 ( ) Copyright Huawei Technologies Co., Ltd. 1

5 2 Applying for a Service 2 Applying for a Service For details about how to apply for a service, see API Use > Applying for a Service in the API Reference. Issue 09 ( ) Copyright Huawei Technologies Co., Ltd. 2

6 3 Obtaining Authentication Information 3 Obtaining Authentication Information Service APIs need to be authenticated. Two authentication methods, token authentication and AK/SK authentication, are available. You are advised to use AK/SK authentication. Step 4 Step 5 Step 6 Register with and log in to the management console. Hover the cursor on the username and select My Credential from the drop-down list. Click the Access Keys tab and then click Add Access Key. Enter the password for login and the verification code received in the or on the mobile phone. Click OK to download the AK/SK. Keep the AK/SK secure. Change the values of ak and sk in the ClientContextUtils.java file of the demo project to the obtained AK/SK. Figure 3-1 Modifying the ClientContextUtils.java file Issue 09 ( ) Copyright Huawei Technologies Co., Ltd. 3

7 4 Obtaining Image SDK 4 Obtaining Image SDK Obtain Image SDK and the related document from Obtain the endpoint of at Regions and Endpoints. Issue 09 ( ) Copyright Huawei Technologies Co., Ltd. 4

8 5 Preparing the Environment 5 Preparing the Environment Table 5-1 describes the environment to be prepared for using Image SDK. Table 5-1 Development environment Item Operating system (OS) JDK installation Description Windows OS. Windows 7 or later is recommended. Basic configuration for the Java development environment. The 1.8 version is strongly recommended. Issue 09 ( ) Copyright Huawei Technologies Co., Ltd. 5

9 6.1 Preparing a Java Development Environment Image Java SDK uses Java SE Development Kit 8 (JDK 8) or later. The following uses JDK 8 (Windows x64) running on Windows 7 as an example. If you have downloaded the JDK and configured the environment, skip this section. Step 4 Download the JDK file from index.html. After the JDK file is downloaded, install the JDK as prompted. For example, install the JDK to the C:\Program Files\Java\jdk1.8.0_131 directory on the local PC. Right-click Computer, choose Properties > Advanced System Settings > Environment Variables, and perform the following operations to configure Java environment variables: 1. Create system variable JAVA_HOME whose value is the JDK installation path. 2. Add %JAVA_HOME%\bin;%JAVA_HOME%\jre\bin to Path. Separate multiple values with semicolons (;). 3. Create system variable CLASSPATH whose value is %JAVA_HOME%\lib\dt.jar; %JAVA_HOME%\lib\tools.jar. Open the command line interface (CLI) and run java -version. If the information shown in Figure 6-1 is displayed, the configuration is successful. Figure 6-1 Java version information 6.2 Installing Eclipse and Importing SDK Projects The following uses Eclipse as an example to describe how to import the SDK project. Operations of other IDEs are similar to those of Eclipse. Issue 09 ( ) Copyright Huawei Technologies Co., Ltd. 6

10 Download Eclipse, for example, eclipse-jee-mars-r-win32-x86_64.zip, from Step 4 Step 5 Extract and open Eclipse. Configure the correct JRE path in Windows > Preferences > Java > Installed JREs. Right-click Package Explorer on the left, and click Import. Choose Maven > Existing Maven Projects, and click Next. Then click Browse, and select the path where ais-imagejava-sdk resides. Click Finish to import the SDK. After the SDK is imported, open the project. The project directory is as follows: Figure 6-2 Project directory 6.3 Demo Project of Image Tagging Two authentication methods, token authentication and AK/SK authentication, are available. This section uses AK/SK authentication as an example. This demo project corresponds to the POST /v1.0/image/tagging URI. You only need to modify the AK/SK instead of compiling code. Issue 09 ( ) Copyright Huawei Technologies Co., Ltd. 7

11 Configure the AK/SK based on Obtaining Authentication Information. Select a local image or use the default image in the demo project. Modify the image path in the ImageTaggingDemo.java file based on Figure 6-3. Figure 6-3 Image path Execute the ImageTaggingDemo.java file. If 200 is displayed on the console, the program is successfully executed. The result is outputted on the console. See Figure 6-4. Figure 6-4 Execution result 6.4 Demo Project of Celebrity Recognition Two authentication methods, token authentication and AK/SK authentication, are available. This section uses AK/SK authentication as an example. This demo project corresponds to the POST /v1.0/image/celebrity-recognition URI. You only need to modify the AK/SK instead of compiling code. Configure the AK/SK based on Obtaining Authentication Information. Select an image of a political figure or Internet celebrity and modify the image path in the CelebrityRecognitionDemo.java file based on Figure 6-5. Figure 6-5 Image path Execute the CelebrityRecognitionDemo.java file. If 200 is displayed on the console, the program is successfully executed. The console outputs the celebrity recognition result (because the default image does not contain any portrait, the result is empty). See Figure 6-6. Issue 09 ( ) Copyright Huawei Technologies Co., Ltd. 8

12 Figure 6-6 Execution result 6.5 Demo Project of Recapture Detection Two authentication methods, token authentication and AK/SK authentication, are available. This section uses AK/SK authentication as an example. This demo project corresponds to the POST /v1.0/image/recapture-detect URI. You only need to modify the AK/SK instead of compiling code. Configure the AK/SK based on Obtaining Authentication Information. Select a local image or use the default image in the demo project. Modify the image path in the RecaptureDetectionDemo.java file based on Figure 6-7. Figure 6-7 Image path Execute the RecaptureDetectionDemo.java file. If 200 is displayed on the console, the program is successfully executed. The result is outputted on the console. See Figure 6-8. Figure 6-8 Execution result 6.6 Demo Project of Dark Enhance Two authentication methods, token authentication and AK/SK authentication, are available. This section uses AK/SK authentication as an example. This demo project corresponds to the POST /v1.0/vision/dark-enhance URI. You only need to modify the AK/SK instead of compiling code. Configure the AK/SK based on Obtaining Authentication Information. Select a local image or use the default image in the demo project. Modify the path where the original image resides and the path where the enhanced image resides in the DarkEnhanceDemo.java file based on Figure 6-9. Issue 09 ( ) Copyright Huawei Technologies Co., Ltd. 9

13 Figure 6-9 Image paths Execute the DarkEnhanceDemo.java file. If 200 is displayed on the console, the program is successfully executed. Figure 6-10 shows the original image and enhanced image. Figure 6-10 Comparison between the original image and enhanced image 6.7 Demo Project of Defog Two authentication methods, token authentication and AK/SK authentication, are available. This section uses AK/SK authentication as an example. This demo project corresponds to the POST /v1.0/vision/defog URI. You only need to modify the AK/SK instead of compiling code. Issue 09 ( ) Copyright Huawei Technologies Co., Ltd. 10

14 Configure the AK/SK based on Obtaining Authentication Information. Select a local image or use the default image in the demo project. Modify the path where the original image resides and the path where the defogged image resides in the DefogDemo.java file based on Figure Figure 6-11 Image paths Execute the DefogDemo.java file. If 200 is displayed on the console, the program is successfully executed. Figure 6-12 shows the original image and defogged image. Figure 6-12 Comparison between the original image and defogged image 6.8 Demo Project of Super Resolution Two authentication methods, token authentication and AK/SK authentication, are available. This section uses AK/SK authentication as an example. Issue 09 ( ) Copyright Huawei Technologies Co., Ltd. 11

15 This demo project corresponds to the POST /v1.0/vision/super-resolution URI. You only need to modify the AK/SK instead of compiling code. Configure the AK/SK based on Obtaining Authentication Information. Select a local image or use the default image in the demo project. Modify the path where the original image resides and the path where the reconstructed image resides in the SuperResolutionDemo.java file based on Figure Figure 6-13 Image paths Execute the SuperResolutionDemo.java file. If 200 is displayed on the console, the program is successfully executed. Figure 6-14 shows the original image and reconstructed image. Figure 6-14 Comparison between the original image and reconstructed image 6.9 Demo Project of BMR Two authentication methods, token authentication and AK/SK authentication, are available. This section uses AK/SK authentication as an example. This demo project corresponds to the POST /v1.0/bgm/recognition URI. You only need to modify the AK/SK instead of compiling code. Issue 09 ( ) Copyright Huawei Technologies Co., Ltd. 12

16 Configure the AK/SK based on Obtaining Authentication Information. Change the video URL in the ASRBgmDemo.java file to the video URL on OBS as highlighted in Figure Figure 6-15 Changing the video URL Execute the ASRBgmDemo.java file. If 200 is displayed on the console, the program is successfully executed. The result is outputted on the console. See Figure Figure 6-16 Execution result 6.10 SDK Project Using Token Authentication Two authentication methods, token authentication and AK/SK authentication, are available. This section uses token authentication as an example. (You can use Image Tagging after performing the following operations. You only need to change the username and password instead of compiling code.) Open the TokenDemo.java file in the com.huawei.ais.demo package, and change the values of username and password in the main function to the actual username and password registered with the system. See Figure Figure 6-17 Modifying username and password Issue 09 ( ) Copyright Huawei Technologies Co., Ltd. 13

17 After modification, run the TokenDemo.java file. On the console, you can see the recognition result using token authentication. Issue 09 ( ) Copyright Huawei Technologies Co., Ltd. 14

18 A Appendix A Appendix A.1 Change History Release Date What's New This is the ninth official release. Modified the following content: Changed the endpoint of to image.cnnorth-1.myhuaweicloud.com This is the eighth official release. Added the following content: Added Demo Project of BMR This is the seventh official release. Added the following content: Added Introduction to Image SDK. Added Preparing the Environment This is the sixth official release. Added the following content: Added Demo Project of Celebrity Recognition This is the fifth official release. Modified the following content: Changed the reference document about how to apply for a service to the API Reference This is the fourth official release. Modified the following content: Modified the project import path in Installing Eclipse and Importing SDK Projects. Issue 09 ( ) Copyright Huawei Technologies Co., Ltd. 15

19 A Appendix Release Date What's New This is the third official release. Added the following content: Added Demo Project of Dark Enhance. Added Demo Project of Defog. Added Demo Project of Super Resolution This is the second official release. Modified the following content: Modified the obtained information in Applying for a Service This is the first official release. Issue 09 ( ) Copyright Huawei Technologies Co., Ltd. 16