Skip to content

Commit b907821

Browse files
authored
Merge pull request #2136 from verilog-to-routing/placement_command_options_doc_update
Placement command line options is updated in documentation
2 parents 7da51f7 + 7467e2d commit b907821

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

doc/src/vpr/command_line_usage.rst

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -665,15 +665,26 @@ If any of init_t, exit_t or alpha_t is specified, the user schedule, with a fixe
665665
**Default:** ``on`` if timing-driven placement is specified, ``off`` otherwise.
666666

667667
.. option:: --inner_num <float>
668+
669+
The number of moves attempted at each temperature in placement can be calculated from inner_num scaled with circuit size or device-circuit size as specified in ``place_effort_scaling``.
668670

669-
The number of moves attempted at each temperature is inner_num * num_blocks^(4/3) in the circuit.
670-
The number of blocks in a circuit is the number of pads plus the number of clbs.
671671
Changing inner_num is the best way to change the speed/quality tradeoff of the placer, as it leaves the highly-efficient automatic annealing schedule on and simply changes the number of moves per temperature.
672672

673673
Specifying ``-inner_num 10`` will slow the placer by a factor of 10 while typically improving placement quality only by 10% or less (depends on the architecture).
674674
Hence users more concerned with quality than CPU time may find this a more appropriate value of inner_num.
675675

676-
**Default:** ``1.0``
676+
**Default:** ``0.5``
677+
678+
.. option:: --place_effort_scaling {circuit | device_circuit}
679+
680+
Controls how the number of placer moves level scales with circuit and device size:
681+
682+
* ``circuit``: The number of moves attempted at each temperature is inner_num * num_blocks^(4/3) in the circuit.
683+
* ``device_circuit``: The number of moves attempted at each temperature is inner_num * grid_size^(2/3) * num_blocks^(4/3) in the circuit.
684+
685+
The number of blocks in a circuit is the number of pads plus the number of clbs.
686+
687+
**Default:** ``circuit``
677688

678689
.. option:: --init_t <float>
679690

0 commit comments

Comments
 (0)