You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Tutorial Checkdata: Sample Application on AITRIOS
2
2
3
3
## Contents
4
+
4
5
-[Contents](#contents)
5
6
-[Overview](#overview)
6
7
-[Get Started](#get-started)
@@ -13,20 +14,20 @@
13
14
-[Trademark](#trademark)
14
15
-[Notice](#notice)
15
16
16
-
17
17
## Overview
18
18
19
-
This repository provides sample code for a [Flask](https://flask.palletsprojects.com/en/2.3.x/) Web API that uses [Console Access Library for Python](https://github.com/SonySemiconductorSolutions/aitrios-sdk-console-access-lib-python) to respond inference results to a [frontend application (aitrios-sample-application-check-data-tool-ts)](https://github.com/SonySemiconductorSolutions/aitrios-sample-application-check-data-tool-ts), as well as configuration files for building a development environment. This application builds an API to retrieve and return object detection based metadata from AITRIOS | Console.
19
+
This repository provides sample code for a [Flask](https://flask.palletsprojects.com/en/2.3.x/) Web API that uses [Console Access Library for Python](https://github.com/SonySemiconductorSolutions/aitrios-sdk-console-access-lib-python) to respond inference results to a [frontend application (aitrios-sample-application-check-data-tool-ts)](https://github.com/SonySemiconductorSolutions/aitrios-sample-application-check-data-tool-ts), as well as configuration files for building a development environment. This application builds an API to retrieve and return object detection based metadata from Console.
20
20
21
21
## Get Started
22
22
23
23
### Build an environment and get started with the sample application
24
24
25
25
1. Clone or fork this application in your GitHub environment.
26
26
2. Click the `+` button to create a codespace on the GitHub environment. See [how to create a codespace](https://docs.github.com/en/codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository).
27
-
3. Create console access setting configuration file with real values under [src/data_loader/common/config/](./src/data_loader/common/config/console_access_settings.yaml.sample).
27
+
3. Create console access setting configuration file with real values under [src/data_loader/common/config/](./src/data_loader/common/console_access_settings.yaml.sample).
@@ -35,39 +36,40 @@ This repository provides sample code for a [Flask](https://flask.palletsprojects
35
36
```
36
37
37
38
> **Note**
38
-
> * Specify the base URL
39
-
> * Specify the token URL
40
-
> * Specify registered application secret for client_secret
41
-
> * Specify registered application client ID for client_id
39
+
> - Specify the base URL
40
+
> - Specify the token URL
41
+
> - Specify registered application secret for client_secret
42
+
> - Specify registered application client ID for client_id
42
43
43
-
See the [Portal user manual](https://developer.aitrios.sony-semicon.com/documents/portal-user-manual/) for details.
44
+
See the [Portal user manual](https://developer.aitrios.sony-semicon.com/en/edge-ai-sensing/documents/portal-user-manual/) for details.
44
45
4. Run the sample application using the following command.
45
-
```
46
+
47
+
```sh
46
48
$ cd ./src
47
49
$ flask run --debugger --reload
48
50
```
51
+
49
52
5. Open `localhost:5000` in a browser and verify that the application is running.
50
53
51
54
> **Note**
52
55
> Please check only for codespaces users!
53
-
>
56
+
>
54
57
> **Public Ports (Front-end application link)**
55
58
> To link with the front-end application, follow the steps below to make the port on codespaces public.
56
59
> 1. Open a terminal and open the [Port] tab. Right-click on the port that will be shared and, after clicking on [Port Display Range], click on [Public].
57
60
> 2. Click on the copy icon on the right side of the port’s local adress and copy it.
Copy file name to clipboardExpand all lines: jupyter_notebook/cloud_sdk_tutorial_en.ipynb
+10-10Lines changed: 10 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -33,14 +33,14 @@
33
33
"cell_type": "markdown",
34
34
"metadata": {},
35
35
"source": [
36
-
"## Step1 Retrieve the Device list information connected to AITRIOS\n",
36
+
"## Step1 Retrieve the Device list information connected to Console\n",
37
37
"\n",
38
-
"- 1. Retrieving the Client\n",
39
-
"- 2. Retreving the Device list information connected to AITRIOS\n",
38
+
"- 1. Create a client to connect to Console\n",
39
+
"- 2. Retrieve the Edge Device list information connected to Console\n",
40
40
"\n",
41
41
"### 1. Retrieving the Client\n",
42
42
"\n",
43
-
"* Call the `get_console_client` function and, using the connection destination information described in `console_access_settings.yaml`, a Client used to connect to AITRIOS is created. For information on how to create a Client, refer to [REST API authentication](https://developer.aitrios.sony-semicon.com/en/file/download/rest-api-authentication).\n",
43
+
"* Call the `get_console_client` function and, using the connection destination information described in `console_access_settings.yaml`, a client used to connect to Console is created. For information on how to create a client, refer to [REST API authentication](https://developer.aitrios.sony-semicon.com/en/file/download/edge-ai-sensing-portal-console-end-point-info/).\n",
44
44
"* It is assumed that the `console_access_settings.yaml` file is placed in the same directory as `tutorial_sample.ipynb` but is is also possible to place it elsewhere by editing the file path of `console_access_settings_dir` according to what is needed.\n",
45
45
"\n",
46
46
"```yaml:console_access_settings.yaml\n",
@@ -81,11 +81,11 @@
81
81
"cell_type": "markdown",
82
82
"metadata": {},
83
83
"source": [
84
-
"### 2. Creating a function to retrieve the Device list information\n",
84
+
"### 2. Creating a function to retrieve the Edge Device list information\n",
85
85
"\n",
86
86
"Create the `get_devices` function with the following functionalities. \n",
87
-
"1. Execute `client_obj.device_management.get_devices()` and retrieve the Device information\n",
88
-
"2. Store the obtained device information in id_list and return it. "
87
+
"1. Execute `client_obj.device_management.get_devices()` and retrieve the Edge Device information\n",
88
+
"2. Store the obtained device information in id_list and return it"
89
89
]
90
90
},
91
91
{
@@ -140,7 +140,7 @@
140
140
"## Step2 Retrieve the image directory information for the selected Device \n",
141
141
"\n",
142
142
"Create the `get_image_directories` function that has the following functionality. \n",
143
-
"1. Using the Device name retrieved earlier as an argument of `client_obj.insight.get_image_directories`, retrieve the image folder name associated with the Device name. "
143
+
"1. Using the Device name retrieved earlier as an argument of `client_obj.insight.get_image_directories`, retrieve the image folder name associated with the Edge Device name. "
144
144
]
145
145
},
146
146
{
@@ -432,13 +432,13 @@
432
432
"`get_deserialize_data.py` is explained in detail below. \n",
433
433
"\n",
434
434
"1. First, the FlatBuffers schema under `src.common.deserialize` is imported.\n",
435
-
" - If the object detection ppl provided by the preset of the AITRIOS Console is being used, this file does not need to be modified.\\\n",
435
+
" - If the object detection ppl provided by the preset of Console is being used, this file does not need to be modified.\\\n",
0 commit comments