Repository navigation
docs: install the package with --no-deps for development - #3051
Mohammed Alkindi (MohammedAlkindi) wants to merge 3 commits into
Conversation
requirements-dev.txt pins onnx-weekly, then pip install -e . resolves the onnx>=1.17 dependency and installs stable onnx over it, because pip treats the two as unrelated distributions. noxfile.py already passes --no-deps at every install of the package for this reason.
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The documentation change correctly aligns local setup with existing nox installation behavior.
Review effort: Balanced
Findings: None
What changed in this PR
Updates development installation instructions to preserve the pinned onnx-weekly package.
Changes:
- Adds
--no-depsto the editable package installation.
| File | Description |
|---|---|
| README.md | Prevents pip from installing stable onnx over onnx-weekly. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3051 +/- ##
==========================================
+ Coverage 72.73% 73.01% +0.27%
==========================================
Files 265 267 +2
Lines 32358 32641 +283
Branches 3069 3101 +32
==========================================
+ Hits 23536 23832 +296
+ Misses 7779 7767 -12
+ Partials 1043 1042 -1 ☔ View full report in Codecov by Harness. |
Blocking findingHigh: the documented clean development setup no longer installs onnx_irLocation: The preceding The motivation to avoid installing stable ONNX over onnx-weekly is valid, but disabling all dependency resolution requires the prerequisite requirements to supply all runtime dependencies. The cited nox precedent is not equivalent: nox explicitly includes/installs Recommended fix: update the development requirements or the documented prerequisite command to explicitly install the supported onnx_ir version, and audit the other package runtime requirements for completeness. Keep Confidence: high. Evidence is from the exact-head dependency manifest, development requirements, unconditional import, and nox installation sequence. This is a newly introduced dependency omission, not an objection to the existing ONNX-weekly setup. |
G. Ramalingam (gramalingam)
left a comment
There was a problem hiding this comment.
Copilot indicates potential issues
|
Done in 6e537b7. The README now installs |
The documented dev setup leaves a contributor without the pinned
onnx-weekly.requirements-dev.txt:3pinsonnx-weekly>=1.17.0.dev20240325. The next line,pip install -e ., resolvesonnx>=1.17frompyproject.toml, and pip treatsonnxandonnx-weeklyas unrelated distributions, so it installs stableonnxon top of the weekly build.Measured in a clean venv on Python 3.13:
pip reports the transitive dependencies as already satisfied but still collects
onnxitself, so the editable install replaces what the previous line pinned.noxfile.pyalready passes--no-depsat every install of the package, at lines 67, 83, 84, 94, 96 and 115, which is the same guard applied to CI but not to the documented path.Running
python docs/update_readme.pyafter the change produces no further diff, so theupdate_readmejob'sgit diff --exit-code -- README.mdstill passes.