astral-sh/uv

Add incremental resolution benchmark to codspeed

Open

#6,418 opened on Aug 22, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Rust (84,934 stars) (3,111 forks)batch import
help wantedperformance

Description

There are three scenarios for the uv resolver:

  • Fresh resolution: We have a set of requirements, but no lockfile. We need to figure a resolution without any prior context. These are continuously tested by resolve_warm_airflow, resolve_warm_jupyter and resolve_warm_jupyter_universal.
  • Incremental resolution: We have a lockfile that gives us preferences for versions (and help prefetching), but it's incompatible or incomplete with the requirements. This happens in a lot of cases, e.g. when pyproject.toml changed due to a version upgrade, with uv lock --upgrade-package or when using uv run --with. Our goal is to resolve versions that preserve most of the existing lockfile.
  • We run uv lock and the lockfile matches: We only need to check against package.metadata.requires-dist.

While we have good coverage for the first case and the last case is fast beyond the need for optimization (<20ms even for transformers with all extras), we don't have good coverage for the middle case. We should add a scenario to codspeed, with a universal resolution where the requirements changes so that they don't match uv.lock anymore.

Contributor guide

Tech stack
rust
Domain
performance
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with RustUnderstanding of uv resolverKnowledge of codspeed benchmarks
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Examine existing codspeed benchmark scenarios in the repository (e.g., `resolve warm airflow`) to understand the pattern. Create a new scenario that starts with a lockfile and modifies requirements to simulate an incremental resolution. The benchmark should measure the performance of the resolver when it cannot fully reuse the lockfile and must resolve incrementally.