[Autotuner] Improve python package management #2859

luarss · 2025-02-16T10:46:04Z

uses uv, a fast rust based package manager for python.
handles dependencies from python 3.8 - 3.10

tools/AutoTuner/pyproject.toml

tools/AutoTuner/src/autotuner/distributed.py

vvbandeira · 2025-03-26T17:34:02Z

tools/AutoTuner/src/autotuner/utils/plot.py

@@ -41,7 +41,9 @@ def load_dir(dir: str) -> pd.DataFrame:
    params = []
    failed = []
    for params_fname in glob.glob(f"{dir}/*/params.json"):
-        metrics_fname = params_fname.replace("params.json", "metrics.json")
+        metrics_fname = params_fname.replace("params.json", "metrics.json").replace(
+            "ray", "or-0"


Why do we need to replace ray with or-0?

In latest Ray versions this is an example file structure (or is replaced with or-0)

autotuner-best-5dfabe02.json searcher-state-2025-02-18_17-10-34.pkl experiment_state-2025-02-18_17-10-34.json variant-AutoTunerBase-5dfabe02-or-0 search_gen_state-2025-02-18_17-10-34.json variant-AutoTunerBase-5dfabe02-ray

https://jenkins.openroad.tools/job/OpenROAD-flow-scripts-Public/job/PR-2859-head/lastSuccessfulBuild/artifact/flow/logs/asap7/gcd/tune-df80c9dd/

vvbandeira · 2025-03-26T17:35:59Z

docs/user/InstructionsForAutoTuner.md

@@ -232,6 +232,11 @@ python3 ./tools/AutoTuner/test/smoke_test_tune.py
 python3 ./tools/AutoTuner/test/smoke_test_sample_iteration.py
 ```

+## Developer reference
+
+1. The [`uv`](https://docs.astral.sh/uv) package manager is used for handling different package requirements in AutoTuner.


What problem uv resolves that pip or venv do not?

Fastest python package manager/resolver

It also acts as a catch-all for pip, venv and additionally pip-tools - which can manage python dependencies across different operating systems and versions.

pip and venv are cross OS, right? And if we are committing the requirements file, this feature of supporting multiple versions (of Python?) will be lost.

The committed requirements file actually is the solved deps for these versions, if not an error will be reported during uv compilation.

vvbandeira · 2025-03-26T17:36:26Z

tools/AutoTuner/Makefile

+	@uv pip compile --output-file=requirements.txt pyproject.toml --upgrade
+	@uv pip compile --output-file=requirements-dev.txt pyproject.toml --extra dev  --upgrade


If we are generating the files, why keep them in git?

For faster dependency resolving. The idea is to first store the solved dependencies in uv.lock and requirements*.txt file and next time, we can just install directly from these files

This also has a side benefit of locking the python versions installed.

I am still not sold on this. What is the process exactly? We update pyproject.toml, then use uv to generate uv.lock and requirements.txt, and finally use pip to install the requirements.txt? Why not just write requirements.txt? This looks like many extra steps that need to be tracked manually.

If we are using pip to install the dependencies at the end, looks to me that all the extra info that uv saves in the lock file is moot.

Please provide an example of how the files are generated, in order, and used.
Also, provide another example to showcase a situation where having uv will be beneficial.

The idea i was aiming for is to periodically run the uv requirements updater (ci or manually) and if it passes test, merge the updated requirements. This step is supposed to be dev-only, so users need not worry.

You are right that uv.lock file is not used in production - that is just to minimise complexity in Dockerfile. We use vanilla pip install on the compiled requirements.txt file.

edit: No other benefits for now, since we are not using uv.lock in production

tools/AutoTuner/Makefile

Signed-off-by: Jack Luar <[email protected]>

…ards Signed-off-by: Jack Luar <[email protected]>

…p/ray) Signed-off-by: Jack Luar <[email protected]>

…tmp instead of local) Signed-off-by: Jack Luar <[email protected]>

…ctly Signed-off-by: Jack Luar <[email protected]>

Signed-off-by: Jack Luar <[email protected]>

… reliably - currently under gp/dp constraint -> 0.625 of the configurations are valid. if we use 5 samples -> only 0.625*0.625*5 ~ 1.9 samples will be valid. - if we use 8 samples ~ 3.1 samples will be valid. Signed-off-by: Jack Luar <[email protected]>

Signed-off-by: Jack Luar <[email protected]>

luarss added the autotuner Flow autotuner label Feb 16, 2025

vvbandeira reviewed Feb 16, 2025

View reviewed changes

tools/AutoTuner/pyproject.toml Show resolved Hide resolved

luarss marked this pull request as draft February 17, 2025 01:40

luarss marked this pull request as ready for review February 19, 2025 15:44

luarss requested a review from vvbandeira February 19, 2025 15:44

luarss mentioned this pull request Mar 8, 2025

setuptools version requirement breaking Docker-based AutoTuner builds #2888

Closed

vvbandeira reviewed Mar 26, 2025

View reviewed changes

luarss added 12 commits March 27, 2025 14:09

add uv for package management

34931f8

Signed-off-by: Jack Luar <[email protected]>

fix pyproject to include py3.10

4ac8076

Signed-off-by: Jack Luar <[email protected]>

enforce ray <= 2.23, local_dir option is deprecated from ray 2.24 onw…

75638e5

…ards Signed-off-by: Jack Luar <[email protected]>

fix distributed relative path bug (ray 2.10 onwards starts ray in /tm…

53ff9b2

…p/ray) Signed-off-by: Jack Luar <[email protected]>

fix uv lock, fix log_path for new ray (changed working directory to /…

3bd6e3b

…tmp instead of local) Signed-off-by: Jack Luar <[email protected]>

fix file path in plot, refactor openroad util to populate paths corre…

26a6ca0

…ctly Signed-off-by: Jack Luar <[email protected]>

fix openroad_distributed

2d3519c

Signed-off-by: Jack Luar <[email protected]>

fix ref_file_check path

23c5d72

Signed-off-by: Jack Luar <[email protected]>

upgrade urllib

33753db

Signed-off-by: Jack Luar <[email protected]>

remove inexact

62a9f81

Signed-off-by: Jack Luar <[email protected]>

update comment

bed43c8

Signed-off-by: Jack Luar <[email protected]>

luarss force-pushed the topic/upgrade-reqs branch from d8a7266 to bed43c8 Compare March 27, 2025 14:39

luarss requested a review from vvbandeira March 27, 2025 14:43

luarss marked this pull request as draft March 29, 2025 04:03

luarss closed this Apr 13, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Autotuner] Improve python package management #2859

[Autotuner] Improve python package management #2859

luarss commented Feb 16, 2025 •

edited

Loading

vvbandeira Mar 26, 2025

luarss Mar 27, 2025

luarss Mar 27, 2025

vvbandeira Mar 26, 2025

luarss Mar 27, 2025

vvbandeira Mar 27, 2025

luarss Mar 28, 2025

vvbandeira Mar 26, 2025

luarss Mar 27, 2025

luarss Mar 27, 2025

vvbandeira Mar 27, 2025

vvbandeira Mar 27, 2025

luarss Mar 28, 2025 •

edited

Loading

		@uv pip compile --output-file=requirements.txt pyproject.toml --upgrade
		@uv pip compile --output-file=requirements-dev.txt pyproject.toml --extra dev --upgrade

[Autotuner] Improve python package management #2859

[Autotuner] Improve python package management #2859

Conversation

luarss commented Feb 16, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

luarss Mar 28, 2025 • edited Loading

Choose a reason for hiding this comment

luarss commented Feb 16, 2025 •

edited

Loading

luarss Mar 28, 2025 •

edited

Loading