Skip to content

Commit 9b0096f

Browse files
committed
Update README.
1 parent 4e61852 commit 9b0096f

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

docs/user_guide.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,16 @@
44
This software is provided “as is,” without any express or implied warranties. The authors and contributors shall not be held liable for any damages arising from its use. The code may be incomplete or insufficiently tested. Users are solely responsible for evaluating its suitability and assume all associated risks. <br>
55
Note: Contributions are welcome. Please ensure thorough testing before deploying in critical systems.
66

7+
## Note
8+
### Native Mode:
9+
- To achieve optimal performance for model data preprocessing, we should try to use the "native" mode:<br>
10+
- When initializing the model, set the input and output data types to "native" (the default is "float");<br>
11+
- When passing data to the QAI AppBuilder inference function(Inference), provide the format required by the model itself;<br>
12+
- You can obtain the required input and output data format types of the model via the getInputDataType() and getOutputDataType() functions;<br>
13+
- For specific usage, please refer to the [Wisper](../samples/python/whisper_base_en/whisper_base_en.py) example code.<br>
14+
715
## Environment Setup
16+
** For Python developers, from v2.0.0, we don't need to prepare the below libraries since we've included these libraries into QAI AppBuilder extension(*.whl). <br>
817

918
### Qualcomm® AI Runtime SDK
1019

@@ -60,7 +69,7 @@ There're several Python classes from this extension:
6069

6170
## Notes: <br>
6271
a. Plese use the API *LogLevel.SetLogLevel()* for Python project to initialize the log function before you call any other APIs.
63-
c. Refer to Python sample code: <br>
72+
b. Refer to Python sample code: <br>
6473
https://github.com/quic/ai-engine-direct-helper/tree/main/samples/python
6574

6675
## Sample Code(Python)

0 commit comments

Comments
 (0)