Skip to content

Commit 44c0893

Browse files
Docs: add warning about MtlManager in the run.md (#1132)
Change the run to inlcude warning about MtlManager as clinets are oftentimes running into lcore assigmnet issues which could be avoided by signaling them to use MtlManager in clear enough form.
1 parent 625ddff commit 44c0893

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

doc/run.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,18 @@ The number is dependent on the workloads you wish to execute. Consider increasin
144144

145145
## 5. Run the Sample Application
146146

147+
> **WARNING:** It is crucial to run the MTL Manager using the Bash command
148+
> ```bash
149+
> sudo MtlManager
150+
> ```
151+
> before attempting to run more than one MTL process per machine or server.
152+
>
153+
> Failure to do so will result in improper logical core (lcore) management, as all MTL
154+
> processes will allocate on the same cores, leading to severe performance degradation
155+
> and potential system instability.
156+
>
157+
> For detailed instructions and further information, please refer to the [manager/README.md](../manager/README.md)
158+
147159
### 5.1. Prepare Source Files
148160
149161
Please note that the input YUV source file for the sample application is in the RFC4175 YUV422BE10 (big-endian 10-bit) pixel group format, which is defined in the ST2110 specification. This project includes a simple tool to convert the format from YUV422 planar 10-bit little-endian format.

0 commit comments

Comments
 (0)