Skip to content

Commit e1b74d5

Browse files
aws-donkretsawsjoshir
authored andcommitted
Updated compiler command-line page
Moved the description of the verbose flag to body of the text to match other options.
1 parent c80bc71 commit e1b74d5

File tree

1 file changed

+18
-14
lines changed

1 file changed

+18
-14
lines changed

compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.rst

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,26 +21,17 @@ Usage
2121

2222
.. option:: neuronx-cc <command> [parameters]
2323

24-
Common parameters for the Neuron CLI:
25-
26-
- :option:`--verbose <level>`: Specify the level of output produced by the compiler. (Default: ``warning``)
24+
Available Commands:
25+
~~~~~~~~~~~~~~~~~~~~~~~
2726

28-
Valid values:
27+
- :option:`compile`
28+
- :option:`list-operators`
2929

30-
- ``info``: Informational messages regarding the progress of model compilation (written to stdout).
31-
- ``warning``: Diagnostic messages that report model code that is not inherently erroneous but may be risky or suggest there may have been an error (written to stderr).
32-
- ``error``: The compiler detected a condition causing it not complete the compilation successfully (written to stderr).
33-
- ``critical``: The compiler encountered an unrecoverable error terminates immediately (written to stderr).
34-
- ``debug``: Extensive information regarding the compiler's internal execution phases (written to stdout).
30+
Common parameters for the Neuron CLI:
3531

3632
- :option:`--help`: Display a usage message of compiler options.
3733
Use :option:`neuronx-cc <command> --help` for information on a specific command.
3834

39-
Available Commands:
40-
~~~~~~~~~~~~~~~~~~~~~~~
41-
42-
- :option:`compile`
43-
- :option:`list-operators`
4435

4536
.. _neuronx-cc-compile:
4637

@@ -50,6 +41,7 @@ Available Commands:
5041

5142
Compile a model for use on the AWS Machine Learning Accelerator.
5243

44+
5345
.. code-block:: shell
5446
5547
neuronx-cc compile <model_files>
@@ -67,6 +59,8 @@ Available Commands:
6759
[--enable-fast-loading-neuron-binaries]
6860
[--logfile <filename>]
6961
[--output <filename>]
62+
[--verbose <level>]
63+
7064
7165
*Compile Parameters:*
7266

@@ -159,6 +153,16 @@ Available Commands:
159153

160154
- :option:`--output <filename>`: Filename where compilation output (NEFF archive) will be recorded. (Default: "file.neff”)
161155

156+
- :option:`--verbose <level>`: Specify the level of output produced by the compiler. (Default: ``warning``)
157+
158+
Valid values:
159+
160+
- ``info``: Informational messages regarding the progress of model compilation (written to stdout).
161+
- ``warning``: Diagnostic messages that report model code that is not inherently erroneous but may be risky or suggest there may have been an error (written to stderr).
162+
- ``error``: The compiler detected a condition causing it not complete the compilation successfully (written to stderr).
163+
- ``critical``: The compiler encountered an unrecoverable error terminates immediately (written to stderr).
164+
- ``debug``: Extensive information regarding the compiler's internal execution phases (written to stdout).
165+
162166
*Example*:
163167
Compiling an XLA HLO:
164168

0 commit comments

Comments
 (0)