Skip to content

Commit cf9003a

Browse files
put sphinx tables to mardown comments (#3346) (#3348)
1 parent aaf97e4 commit cf9003a

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

tools/model_tools/README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ pip install .
5959
To convert models from certain frameworks, you may also need to install
6060
additional dependencies.
6161

62+
<!--
6263
@sphinxdirective
6364
6465
.. tab:: PyTorch
@@ -80,6 +81,7 @@ additional dependencies.
8081
python -mpip install --user -r ./requirements-paddle.in
8182
8283
@endsphinxdirective
84+
-->
8385

8486
## Model Downloader Usage
8587

@@ -95,6 +97,7 @@ section.
9597

9698
### Model Downloader Starting Parameters
9799

100+
<!--
98101
@sphinxdirective
99102
100103
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
@@ -113,7 +116,7 @@ section.
113116
| ``--progress_format`` | By default, the script outputs progress information as unstructured, human-readable text. You can also set this option to `text` to explicitly request the default text format. When this option is set to `json`, the script's standard output is replaced by a machine-readable progress report, whose format is documented in the "JSON progress report format" section. This option does not affect errors and warnings, which will still be printed to the standard error stream in a human-readable format. Use this option, if you want to consume progress information programmatically. | ``omz_downloader --all --progress_format=json`` |
114117
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
115118
@endsphinxdirective
116-
119+
-->
117120

118121
See the "Shared options" section for information on other options accepted by
119122
the script.
@@ -130,6 +133,7 @@ additional members it contains.
130133

131134
The following event types are currently defined:
132135

136+
<!--
133137
@sphinxdirective
134138
135139
+------------------------------------+-------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -150,7 +154,7 @@ The following event types are currently defined:
150154
| ``model_postprocessing_end`` | ``model`` | The script stopped post-download processing on the model named by ``model``. |
151155
+------------------------------------+-------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
152156
@endsphinxdirective
153-
157+
-->
154158

155159
Additional event types and members may be added in the future.
156160

@@ -182,6 +186,7 @@ a subset of models. See the "Shared options" section.
182186

183187
### Model Converter Starting Parameters
184188

189+
<!--
185190
@sphinxdirective
186191
187192
+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
@@ -202,7 +207,7 @@ a subset of models. See the "Shared options" section.
202207
| ``-p``/``--python`` | By default, the script will run Model Optimizer using the same Python executable that was used to run the script itself. Apply this parameter to use a different Python executable. | ``omz_converter --all --python my/python`` |
203208
+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
204209
@endsphinxdirective
205-
210+
-->
206211

207212
The script will attempt to locate Model Optimizer using several methods:
208213

@@ -242,6 +247,7 @@ are ignored.
242247
The `--all` option can be replaced with other filter options to quantize only
243248
a subset of models. See the "Shared options" section.
244249

250+
<!--
245251
@sphinxdirective
246252
247253
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
@@ -260,7 +266,7 @@ a subset of models. See the "Shared options" section.
260266
| ``-p``/``--python`` | By default, the script will run Model Optimizer using the same Python executable that was used to run the script itself. Apply this parameter to use a different Python executable. | ``omz_quantizer --all --dataset_dir <DATASET_DIR> --python my/python`` |
261267
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
262268
@endsphinxdirective
263-
269+
-->
264270

265271
The script will attempt to locate Post-Training Optimization Toolkit using several methods:
266272

@@ -295,6 +301,7 @@ This will print to standard output information about all models. The script's ou
295301
describing a single model. Each such object has the following keys:
296302

297303

304+
<!--
298305
@sphinxdirective
299306
300307
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -365,7 +372,7 @@ describing a single model. Each such object has the following keys:
365372
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
366373
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
367374
@endsphinxdirective
368-
375+
-->
369376

370377
## Shared Options
371378

@@ -379,6 +386,7 @@ omz_TOOL --help
379386
There are several mutually exclusive filter options that select the models the
380387
tool will process:
381388

389+
<!--
382390
@sphinxdirective
383391
384392
+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
@@ -391,7 +399,7 @@ tool will process:
391399
| ``--list`` | takes a path to a file that must contain a list of patterns and selects models that match at least one of those patterns. For composite models, the name of composite model is accepted, as well as the names of individual models it consists of | ``omz_TOOL --list my.lst`` |
392400
+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
393401
@endsphinxdirective
394-
402+
-->
395403

396404

397405
To see the available models, you can use the `--print_all` option. When this

0 commit comments

Comments
 (0)