README example: Uses `examples/utils` instead of `diffcp.utils`
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- backend, documentation
Research direction
Start with the README example and examples/utils.py, where random_cone_prog is currently defined, then inspect diffcp's package exports. Move the utility as proposed and expose it through diffcp.utils so the README example runs from the package path.
Written by the indexing model from the issue text.
Description
The example in the readme uses diffcp.utils.random_cone_prog which is actually defined here: https://github.com/cvxgrp/diffcp/blob/cbea99715974e36050232d20ff22c38bb92ea91f/examples/utils.py
Perhaps the easiest solution here is to move this inside of diffcp.utils and then add the utils import to __init__ so the example in the README runs?
- Dominant language
- Python
- Stars
- 121
- Forks
- 26
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from cvxgrp/diffcp
-
MOSEK SolverOpen
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 50/100
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
add power coneOpen
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
Similar issues
-
HTML: <template> content is extracted as document textPossibly taken @ryanmeowy claimed this today. Openbug html
Difficulty 1/5 Under an hour Newbie friendliness 82/100
docling-project/docling#4714 · 2 comments ·
Maintainers usually reply within 1 day
-
[BUG] Qdrant RAG client applies score_threshold to raw cosine similarity, not the 0-1 score it returnsPossibly taken @roydonsequeira claimed this today. Openbug
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
ashhart/TensorFold#536 ·
Maintainers usually reply within 1 day
-
area/install-update comp/cli duplicate P2 python:uv sweeper:risk-compatibility type/bug
Difficulty 1/5 Under an hour Newbie friendliness 62/100
NousResearch/hermes-agent#135440 · 1 comment ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Deepak3699/Ai_Mentor#244 ·
Maintainers usually reply within 1 day