Tweak API to make the usage clearer when there is one result or multiple results from optimization #1

New issue

Open

opened 2026-02-13 01:57:46 +00:00 by UserCurt · 0 comments

UserCurt commented

2026-02-13 01:57:46 +00:00

(Migrated from codeberg.org)

When saving layouts using optimize.py, some modes typically return a single result (e.g., nearest or local). However, --output is set up to specify a directory with files prefixed with rank. This can lead to users expecting a single result to accidentally specify the saved directory with a suffix .yaml. This feature request suggests improving the API to make this behavior obvious or not possible. One approach is to use separate commands whether saving the best result (specify a file) or the top-N results (specify a directory).

When saving layouts using `optimize.py`, some modes typically return a single result (e.g., `nearest` or `local`). However, `--output` is set up to specify a directory with files prefixed with rank. This can lead to users expecting a single result to accidentally specify the saved directory with a suffix `.yaml`. This feature request suggests improving the API to make this behavior obvious or not possible. One approach is to use separate commands whether saving the best result (specify a file) or the top-N results (specify a directory).