Skip to content

Commit 7467e2d

Browse files
committed
Placement command line options is updated in documentation
1 parent 6531416 commit 7467e2d

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
@@ -659,15 +659,26 @@ If any of init_t, exit_t or alpha_t is specified, the user schedule, with a fixe
659659
**Default:** ``on`` if timing-driven placement is specified, ``off`` otherwise.
660660

661661
.. option:: --inner_num <float>
662+
663+
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``.
662664

663-
The number of moves attempted at each temperature is inner_num * num_blocks^(4/3) in the circuit.
664-
The number of blocks in a circuit is the number of pads plus the number of clbs.
665665
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.
666666

667667
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).
668668
Hence users more concerned with quality than CPU time may find this a more appropriate value of inner_num.
669669

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

672683
.. option:: --init_t <float>
673684

0 commit comments

Comments
 (0)