Skip to content

Commit

Permalink
Merge pull request #14 from SonySemiconductorSolutions/release/1.1.0
Browse files Browse the repository at this point in the history
release/1.1.0 to main
  • Loading branch information
TE-HironoriKan authored Mar 11, 2024
2 parents 72041cc + ed90111 commit 37474ec
Show file tree
Hide file tree
Showing 412 changed files with 35,133 additions and 16,270 deletions.
69 changes: 47 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@
* Step 1: Create console access setting configuration parameters with real values

(samples\console_access_settings.yaml).
In the case of using "**Console Developer Edition**"
```
console_access_settings:
console_endpoint: "__console_endpoint__"
Expand All @@ -54,6 +56,16 @@
client_id: "__client_id__"
```

In the case of using "**Console Enterprise Edition**"
```
console_access_settings:
console_endpoint: "__base_url__"
portal_authorization_endpoint: "https://login.microsoftonline.com/'__tenant_id__'"
client_secret: "__creant_secret__"
client_id: "__client_id__"
application_id: "__application_id__"
```

* Step 2: Import modules **`ReadConsoleAccessSettings`**, **`Config`** and **`Client`** into "**Console Access Library**" sample application

(samples\console_access_client_api_demo.py)
Expand All @@ -80,7 +92,8 @@
config_obj = Config(console_endpoint=read_console_access_settings_obj.console_endpoint,
portal_authorization_endpoint=read_console_access_settings_obj.portal_authorization_endpoint,
client_id=read_console_access_settings_obj.client_id,
client_secret=read_console_access_settings_obj.client_secret)
client_secret=read_console_access_settings_obj.client_secret,
application_id= read_console_access_settings_obj.application_id)
```

* Option 2: Using Environment Variables
Expand All @@ -92,6 +105,7 @@
export PORTAL_AUTHORIZATION_ENDPOINT="__portal_authorization_endpoint__"
export CLIENT_SECRET="__client_secret__"
export CLIENT_ID="__client_id__"
export APPLICATION_ID="__application_id__"
```

* Step 2: Import modules **`Config`** and **`Client`** into "**Console Access Library**" sample application
Expand All @@ -109,7 +123,8 @@
config_obj = Config(console_endpoint=None,
portal_authorization_endpoint=None,
client_id=None,
client_secret=None)
client_secret=None,
application_id=None)
```

* Option 3: Passing real values to "**Console Access Library**" **`Config`**.
Expand All @@ -129,46 +144,56 @@
config_obj = Config(console_endpoint="__console_endpoint__",
portal_authorization_endpoint="__portal_authorization_endpoint__",
client_id="__client_id__",
client_secret="__client_secret__")
client_secret="__client_secret__",
application_id="__application_id__")
```

8. To run "**Console Access Library**" sample application, edit demo configuration parameters with real values.
(samples\demo_config.yaml).
```
demo_configuration:
device_id: "__device_id__"
number_of_images: __number_of_images__
skip: __skip__
sub_directory_name: "__sub_directory_name__"
number_of_inference_results: __number_of_inference_results__
filter: "__filter__"
raw: __raw__
time: "__time__"
get_model_device_id: "__get_model_device_id__"
publish_model_wait_response_device_id: "__publish_model_wait_response_device_id__"
model_id: "__model_id__"
model: "__model__"
converted: "__converted__"
vendor_name: "__vendor_name__"
get_images_order_by: "__get_images_order_by__"
get_last_inference_and_image_data_order_by: "__get_last_inference_and_image_data_order_by__"
key: "__key__"
app_name: "__app_name__"
version_number: "__version_number__"
model: "__model__
model_id: "__model_id__"
compiled_flg: "__compiled_flg__"
file_name: "__file_name__"
comment: "__comment__"
input_format_param: "__input_format_param__"
network_config: "__network_config__"
network_type: "__network_type__"
labels: "__labels__"
metadata_format_id: "__metadata_format_id__"
project_name: "__project_name__"
model_platform: "__model_platform__"
project_type: "__project_type__"
latest_type: "__latest_type__"
config_id: "__config_id__"
sensor_loader_version_number: "__sensor_loader_version_number__"
sensor_version_number: "__sensor_version_number__"
model_version_number: "__model_version_number__"
ap_fw_version_number: "__ap_fw_version_number__"
device_ids: "__device_ids__"
deploy_parameter: "__deploy_parameter__"
replace_model_id: "__replace_model_id__"
timeout: __timeout__
timeout: "__timeout__"
compiled_flg: "__compiled_flg__"
app_name: "__app_name__"
version_number: "__version_number__"
file_name: "__file_name__"
entry_point: "__entry_point__"
schema_info: "__schema_info__"
device_name: "__device_name__"
connection_state: "__connection_state__"
device_group_id: "__device_group_id__"
scope: "__scope__"
sub_directory_name: "__sub_directory_name__"
number_of_images: "__number_of_images__"
skip: "__skip__"
order_by: "__order_by__"
number_of_inference_results: "__number_of_inference_results__"
filter: "__filter__"
raw: "__raw__"
time: "__time__"
```

9. To run API "import_device_app" in "**Console Access Library**" sample application
Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 73f31b81e8cb6e78e40c5a82a9c68863
config: 46f629eb1f712f73805bb4e81e57eeb5
tags: 645f666f9bcd5a90fca523b33c5a78b7
Empty file added docs/api-reference/.nojekyll
Empty file.
Loading

0 comments on commit 37474ec

Please sign in to comment.