Skip to content

Commit e6af24c

Browse files
committed
[CLI] add doc for max_pres_fac
1 parent 26380cc commit e6af24c

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

doc/src/vpr/command_line_usage.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1165,7 +1165,9 @@ VPR uses a negotiated congestion algorithm (based on Pathfinder) to perform rout
11651165

11661166
.. option:: --max_pres_fac <float>
11671167

1168-
Sets the maximum present overuse penalty factor.
1168+
Sets the maximum present overuse penalty factor that can ever result during routing. Should always be less than 1e25 or so to prevent overflow.
1169+
Smaller values may help prevent circuitous routing in difficult routing problems, but may increase
1170+
the number of routing iterations needed and hence runtime.
11691171

11701172
**Default:** ``1000.0``
11711173

0 commit comments

Comments
 (0)