You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: recipes_source/xeon_run_cpu.rst
+17-17Lines changed: 17 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -217,23 +217,23 @@ The generic option settings (knobs) include the following:
217
217
* - ``-h``, ``--help``
218
218
-
219
219
-
220
-
- Show the help message and exit.
220
+
- To show the help message and exit.
221
221
* - ``-m``, ``--module``
222
222
-
223
223
-
224
-
- Changes each process to interpret the launch script as a python module, executing with the same behavior as "python -m".
224
+
- To change each process to interpret the launch script as a python module, executing with the same behavior as "python -m".
225
225
* - ``--no-python``
226
226
- bool
227
227
- False
228
-
- Do not prepend the program with "python" - just exec it directly. Useful when the script is not a Python script.
228
+
- To avoid prepending the program with "python" - just execute it directly. Useful when the script is not a Python script.
229
229
* - ``--log-path``
230
230
- str
231
231
- ``''``
232
-
- The log file directory. Default path is ``''``, which means disable logging to files.
232
+
- To specify the log file directory. Default path is ``''``, which means disable logging to files.
233
233
* - ``--log-file-prefix``
234
234
- str
235
-
- 'run'
236
-
- log file name prefix.
235
+
- "run"
236
+
- Prefix of the log file name.
237
237
238
238
Knobs for applying or disabling optimizations are:
239
239
@@ -248,23 +248,23 @@ Knobs for applying or disabling optimizations are:
248
248
* - ``--enable-tcmalloc``
249
249
- bool
250
250
- False
251
-
- Enable ``TCMalloc`` memory allocator.
251
+
- To enable ``TCMalloc`` memory allocator.
252
252
* - ``--enable-jemalloc``
253
253
- bool
254
254
- False
255
-
- Enable ``JeMalloc`` memory allocator.
255
+
- To enable ``JeMalloc`` memory allocator.
256
256
* - ``--use-default-allocator``
257
257
- bool
258
258
- False
259
-
- Use default memory allocator. Neither ``TCMalloc`` nor ``JeMalloc`` would be used.
259
+
- To use default memory allocator. Neither ``TCMalloc`` nor ``JeMalloc`` would be used.
260
260
* - ``--disable-iomp``
261
261
- bool
262
262
- False
263
263
- By default, Intel(R) OpenMP lib will be used if installed. Setting this flag would disable the usage of Intel(R) OpenMP.
264
264
265
265
.. note::
266
266
267
-
Memory allocator influences performance. If users do not specify a desired memory allocator, the ``run_cpu`` script will search if any of them is installed in the order of TCMalloc > JeMalloc > PyTorch default memory allocator, and takes the first matched one.
267
+
Memory allocators influence performance. If the user does not specify a desired memory allocator, the ``run_cpu`` script will search if any of them is installed in the order of TCMalloc > JeMalloc > PyTorch default memory allocator, and takes the first matched one.
268
268
269
269
Knobs for controlling instance number and compute resource allocation are:
270
270
@@ -283,27 +283,27 @@ Knobs for controlling instance number and compute resource allocation are:
283
283
* - ``--ncores-per-instance``
284
284
- int
285
285
- 0
286
-
- Number of cores used by every instance.
286
+
- Number of cores used by each instance.
287
287
* - ``--node-id``
288
288
- int
289
289
- -1
290
-
- Node id for multi-instance, by default all nodes will be used.
290
+
- The node ID to be used for multi-instance, by default all nodes will be used.
291
291
* - ``--core-list``
292
292
- str
293
293
- ``''``
294
-
- Specify the core list as ``'core_id, core_id, ....'`` or core range as ``'core_id-core_id'``. By dafault all the cores will be used.
294
+
- To specify the core list as ``'core_id, core_id, ....'`` or core range as ``'core_id-core_id'``. By dafault all the cores will be used.
295
295
* - ``--use-logical-core``
296
296
- bool
297
297
- False
298
-
- By default only physical cores are used. Specify this flag to use logical cores.
298
+
- By default only physical cores are used. Specifying this flag enables logical cores usage.
299
299
* - ``--skip-cross-node-cores``
300
300
- bool
301
301
- False
302
-
- Prevent the workload to be executed on cores across NUMA nodes.
302
+
- To prevent the workload to be executed on cores across NUMA nodes.
303
303
* - ``--rank``
304
304
- int
305
305
- -1
306
-
- Specify instance index to assign ncores_per_instance for rank; otherwise ncores_per_instance will be assigned sequentially to the instances.
306
+
- To specify instance index to assign ncores_per_instance for rank; otherwise ncores_per_instance will be assigned sequentially to the instances.
307
307
* - ``--multi-instance``
308
308
- bool
309
309
- False
@@ -323,7 +323,7 @@ Knobs for controlling instance number and compute resource allocation are:
0 commit comments