Merge pull request #3 from SonySemiconductorSolutions/release/1.0.1

Release/1.0.1 to main

Author: UedaSatoshi

.devcontainer/Dependencies/aitrios-sdk-console-access-lib-python

@@ -43,7 +43,9 @@
 
 	// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
 	"remoteUser": "vscode",
-
+	
+	"forwardPorts": [5000],
+	
 	// for git submodules: https://docs.github.com/ja/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces
 	"customizations": {
 		"codespaces": {

.devcontainer/devcontainer.json

@@ -1,3 +1,3 @@
 [submodule ".devcontainer/Dependencies/aitrios-sdk-console-access-lib-python"]
 	path = .devcontainer/Dependencies/aitrios-sdk-console-access-lib-python
-	url = https://github.com/SonySemiconductorSolutions/aitrios-sdk-console-access-lib-python
+	url = https://github.com/SonySemiconductorSolutions/aitrios-sdk-console-access-lib-python

.gitmodules

@@ -16,7 +16,7 @@
 
 ## Overview
 
-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, 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.
+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.
 
 ## Get Started
 
@@ -40,24 +40,36 @@ This repository provides sample code for a [Flask](https://flask.palletsprojects
     > * Specify registered application secret for client_secret
     > * Specify registered application client ID for client_id
 
-    See the [Portal user manual](https://developer.aitrios.sony-semicon.com/file/download/portal-user-manual) for details.
+    See the [Portal user manual](https://developer.aitrios.sony-semicon.com/documents/portal-user-manual/) for details.
 4. Run the sample application using the following command.
     ```
     $ cd ./src
     $ flask run --debugger --reload
     ```
 5. Open `localhost:5000` in a browser and verify that the application is running.
 
+    > **Note**
+    > Please check only for codespaces users!
+    >    
+    > **Public Ports (Front-end application link)**  
+    > To link with the front-end application, follow the steps below to make the port on codespaces public.
+    > 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].
+    > 2. Click on the copy icon on the right side of the port’s local adress and copy it.
+    > 
+
+![codespace_public_port](./docs/20230704_codespace_public_port.png)
+
+
 ## Specifications
 
 ### Functional overview
 
-- Web API to obtain various datas from AITRIOS Console.
-  - An API that can be obtained a list of edge AI devices connected to the Console.
+- Web API to obtain various datas from AITRIOS | Console.
+  - An API that can be obtained a list of edge AI devices connected to the AITRIOS | Console.
   - An API that can be obtained a list of sub-directories containing images taken with the specified device.
   - An API that can be obtained a list of pairs of image and inference result that stored in the Console.
-- Only object detection is supported as baseAI model.
-- It can be run on devcontainer/Codespaces.
+- Only object detection made by Custom Vision is supported.
+- It can be run on devcontainer/codespaces.
 
 ### Restrictions
 
@@ -68,16 +80,16 @@ None
 - [Contact us](https://developer.aitrios.sony-semicon.com/contact-us/)
 
 ## See also
-
+- [Get Started](https://developer.aitrios.sony-semicon.com/development-guides/get-started)
 - [aitrios-sdk-console-access-lib-python](https://github.com/SonySemiconductorSolutions/aitrios-sdk-console-access-lib-python)
 - [aitrios-sdk-cloud-app-sample-python](https://github.com/SonySemiconductorSolutions/aitrios-sdk-cloud-app-sample-python)
 
 
 ## Trademark
-- [Read This First](https://developer.aitrios.sony-semicon.com/development-guides/documents/manuals/)
+- [Read This First](https://developer.aitrios.sony-semicon.com/development-guides/documents/read-this-first/)
 
 ## Notice
 
 ### Security
 
-Before using Codespaces, please read the Site Policy of GitHub and understand the usage conditions.
+Before using Codespaces, please read the Site Policy of GitHub and understand the usage conditions.

README.md

@@ -41,8 +41,7 @@
     "### 1. Clientの取得\n",
     "\n",
     "* `get_console_client`関数を呼び出し、`console_access_settings.yaml`に記載されている接続先情報を用いてAITRIOSに接続するためのClientを作成します。  \n",
-    "* `console_access_settings.yaml`は`tutorial_sample.ipynb`と同じディレクトリに置くことを想定していますが、都合に応じて次セル内の`console_access_settings_dir`のファイルパスを変更することで他においても動作可能です。\n",
-    "\n",
+    "* `/workspace/src/data_loader/common/`に`console_access_settings.yaml`を作成し、`console_access_settings_dir`にファイルパスを記述してください。\n",
     "\n",
     "```yaml:console_access_settings.yaml\n",
     "console_access_settings:\n",
@@ -163,7 +162,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 28,
+   "execution_count": null,
    "metadata": {},
    "outputs": [
     {
@@ -175,7 +174,11 @@
     }
    ],
    "source": [
-    "device_id = devices_list[2]\n",
+    "# devices_list配列から適当なdevice_idを選択してください。\n",
+    "# 本チュートリアルでは、配列の先頭を選択していますが、device_idの文字列指定でも選択できます。\n",
+    "device_id = devices_list[0]\n",
+    "#device_id = \"sid-xxxxxxxxxxxxxxxxxxxxxxx\"\n",
+    "\n",
     "image_directories = get_image_directories(device_id)\n",
     "print(image_directories)"
    ]
@@ -311,9 +314,11 @@
     }
    ],
    "source": [
+    "# device_directory_nameで取得した画像ディレクトリを選択してください。\n",
+    "# 本チュートリアルでは先頭ディレクトリを選択しています。\n",
     "images_data = get_images(device_id=device_id, device_directory_name=image_directories[0])\n",
     "\n",
-    "#画像群から最新の1枚を選択\n",
+    "# 画像群から最新の1枚を選択\n",
     "image_name = images_data[-1][\"name\"]\n",
     "img_base64 = images_data[-1][\"contents\"]\n",
     "\n",
@@ -414,12 +419,12 @@
     "            bbox_2d = BoundingBox2d.BoundingBox2d()\n",
     "            bbox_2d.Init(obj_list.BoundingBox().Bytes, obj_list.BoundingBox().Pos)\n",
     "            buf[str(i + 1)] = {}\n",
-    "            buf[str(i + 1)]['class_id'] = obj_list.ClassId()\n",
-    "            buf[str(i + 1)]['score'] = obj_list.Score()\n",
-    "            buf[str(i + 1)]['left'] = bbox_2d.Left()\n",
-    "            buf[str(i + 1)]['top'] = bbox_2d.Top()\n",
-    "            buf[str(i + 1)]['right'] = bbox_2d.Right()\n",
-    "            buf[str(i + 1)]['bottom'] = bbox_2d.Bottom()\n",
+    "            buf[str(i + 1)]['C'] = obj_list.ClassId()\n",
+    "            buf[str(i + 1)]['P'] = obj_list.Score()\n",
+    "            buf[str(i + 1)]['X'] = bbox_2d.Left()\n",
+    "            buf[str(i + 1)]['Y'] = bbox_2d.Top()\n",
+    "            buf[str(i + 1)]['x'] = bbox_2d.Right()\n",
+    "            buf[str(i + 1)]['y'] = bbox_2d.Bottom()\n",
     "\n",
     "    return buf\n",
     "```\n",
@@ -458,12 +463,12 @@
     "        bbox_2d = BoundingBox2d.BoundingBox2d()\n",
     "        bbox_2d.Init(obj_list.BoundingBox().Bytes, obj_list.BoundingBox().Pos)\n",
     "        buf[str(i + 1)] = {}\n",
-    "        buf[str(i + 1)]['class_id'] = obj_list.ClassId()\n",
-    "        buf[str(i + 1)]['score'] = obj_list.Score()\n",
-    "        buf[str(i + 1)]['left'] = bbox_2d.Left()\n",
-    "        buf[str(i + 1)]['top'] = bbox_2d.Top()\n",
-    "        buf[str(i + 1)]['right'] = bbox_2d.Right()\n",
-    "        buf[str(i + 1)]['bottom'] = bbox_2d.Bottom()\n",
+    "        buf[str(i + 1)]['C'] = obj_list.ClassId()\n",
+    "        buf[str(i + 1)]['P'] = obj_list.Score()\n",
+    "        buf[str(i + 1)]['X'] = bbox_2d.Left()\n",
+    "        buf[str(i + 1)]['Y'] = bbox_2d.Top()\n",
+    "        buf[str(i + 1)]['x'] = bbox_2d.Right()\n",
+    "        buf[str(i + 1)]['y'] = bbox_2d.Bottom()\n",
     "```"
    ]
   },