Skip to content

Commit 1bdfb89

Browse files
committed
grammar correction: know explanations should not use imperative expression
1 parent 391f4ad commit 1bdfb89

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

recipes_source/xeon_run_cpu.rst

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -217,23 +217,23 @@ The generic option settings (knobs) include the following:
217217
* - ``-h``, ``--help``
218218
-
219219
-
220-
- Show the help message and exit.
220+
- To show the help message and exit.
221221
* - ``-m``, ``--module``
222222
-
223223
-
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".
225225
* - ``--no-python``
226226
- bool
227227
- 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.
229229
* - ``--log-path``
230230
- str
231231
- ``''``
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.
233233
* - ``--log-file-prefix``
234234
- str
235-
- 'run'
236-
- log file name prefix.
235+
- "run"
236+
- Prefix of the log file name.
237237

238238
Knobs for applying or disabling optimizations are:
239239

@@ -248,23 +248,23 @@ Knobs for applying or disabling optimizations are:
248248
* - ``--enable-tcmalloc``
249249
- bool
250250
- False
251-
- Enable ``TCMalloc`` memory allocator.
251+
- To enable ``TCMalloc`` memory allocator.
252252
* - ``--enable-jemalloc``
253253
- bool
254254
- False
255-
- Enable ``JeMalloc`` memory allocator.
255+
- To enable ``JeMalloc`` memory allocator.
256256
* - ``--use-default-allocator``
257257
- bool
258258
- 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.
260260
* - ``--disable-iomp``
261261
- bool
262262
- False
263263
- By default, Intel(R) OpenMP lib will be used if installed. Setting this flag would disable the usage of Intel(R) OpenMP.
264264

265265
.. note::
266266

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.
268268

269269
Knobs for controlling instance number and compute resource allocation are:
270270

@@ -283,27 +283,27 @@ Knobs for controlling instance number and compute resource allocation are:
283283
* - ``--ncores-per-instance``
284284
- int
285285
- 0
286-
- Number of cores used by every instance.
286+
- Number of cores used by each instance.
287287
* - ``--node-id``
288288
- int
289289
- -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.
291291
* - ``--core-list``
292292
- str
293293
- ``''``
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.
295295
* - ``--use-logical-core``
296296
- bool
297297
- 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.
299299
* - ``--skip-cross-node-cores``
300300
- bool
301301
- 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.
303303
* - ``--rank``
304304
- int
305305
- -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.
307307
* - ``--multi-instance``
308308
- bool
309309
- False
@@ -323,7 +323,7 @@ Knobs for controlling instance number and compute resource allocation are:
323323
* - ``--disable-taskset``
324324
- bool
325325
- False
326-
- Disable the usage of ``taskset`` command.
326+
- To disable the usage of ``taskset`` command.
327327

328328
.. note::
329329

0 commit comments

Comments
 (0)