Merge pull request #67 from renderbus/zwy

feat: Updated documents related to hardware configuration parameters

Author: foxrenderfarm

render/SDK_tutorial.md

@@ -93,23 +93,7 @@ update_task = {
 update_task_info(update_task, analyze_obj.task_json)
 ```
 
-##### 2. Specify the hardware configuration
-
-The hardware configuration is controlled by the parameter "hardwareconfigid", which can be obtained through the API interface.("API interfaces use methods" --> "Get platform hardware configuration information")
-
-If "ram" and "hardwareconfigid" are set in "Task_info"
-
-以“hardwareConfigId”为主, 没有则以"ram"设置为主.
-
-```
-from rayvision_api.utils import update_task_info, append_to_task, append_to_upload
-update_task = {
-    "hardwareConfigId": "27"  # 指定硬件配置
-}
-update_task_info(update_task, analyze_obj.task_json)
-```
-
-##### 3. task.json add custom parameters
+##### 2. task.json add custom parameters
 
 > The added custom parameters will be integrated into dictionary for key is "additional_info".
  【Warning】：Custom parameters will not take effect immediately. If you have this requirement, please contact our customer service。
@@ -123,7 +107,7 @@ custom_info_to_task = {
 append_to_task(custom_info_to_task, analyze_obj.task_json)
 ```
 
-##### 4. user custom upload.json
+##### 3. user custom upload.json
 > Support custom add file path to upload.json, will automatically deduplicate
 `append_to_upload(files_paths, upload_path)`
 
@@ -136,14 +120,26 @@ custom_info_to_upload = [
 append_to_upload(custom_info_to_upload, analyze_obj.upload_json)
 ```
 
-### IV. Validate json file
+### IV. Setting hardware Configuration and Validate json file
+
+The hardware configuration is controlled by the parameter "hardwareconfigid", which can be obtained through the API interface.("API interfaces use methods" --> "Get platform hardware configuration information")
+
+Specify the hardware configuration by setting `model`, `ram`, `gpuNum` of hardware_config
+
+```
+hardware_config = {
+    "model": "Default",  # Platform CPU: Default or Platform GPU: 1080Ti or 2080Ti
+    "ram": "64GB",  # memory: 64GB or 128GB
+    "gpuNum": None  # GPU platform requires input like 2*GPU, if CPU platform it is None
+}
+```
 
-When validating, we check whether there is' user_id ', 'project_id', 'task_id' in task.json,
+When validating,we set the hardware configuration based on the hardware_config and check whether there is` user_id `, `project_id`, `task_id` in task.json,
 If not, the interface is called to fetch the relevant parameters from the server and write task.json
 
 ```
 check_obj = RayvisionCheck(api, analyze_obj)
-task_id = check_obj.execute(analyze_obj.task_json, analyze_obj.upload_json)
+task_id = check_obj.execute(hardware_config, analyze_obj.task_json, analyze_obj.upload_json)
 ```
 
 ### V. Upload