Latest Results
Add separate QPLIB tutorial notebooks and docs dependency auto-update workflow (#644)
## Summary
This PR includes two main improvements:
### 1. QPLIB Tutorial Addition
Created dedicated QPLIB tutorial notebooks separate from MIPLIB:
- **Separate Notebooks**: Created `download_qplib_instance.ipynb` for
both English and Japanese
- **Updated TOC**: Added entries to both `docs/en/_toc.yml` and
`docs/ja/_toc.yml`
- **QPLIB Introduction**: Explanation of QPLIB as quadratic programming
benchmark library
- **Code Examples**: Sample code using `dataset.qplib("0018")` and
PySCIPOpt adapter
- **Annotation Documentation**: Focus on QPLIB-specific annotations with
reference to official documentation
- **QPLIB-specific annotations**: `org.ommx.qplib.probtype`, `objtype`,
`objcurvature`, etc.
- **Links**: References to QPLIB website, GitHub Container Registry, and
official QPLIB documentation at https://qplib.zib.de/doc.html
- **Clean Separation**: MIPLIB notebooks remain unchanged, focusing
solely on MIPLIB content
### 2. Docs Dependency Auto-Update Infrastructure
Implemented automated workflow to keep documentation dependencies
up-to-date with released OMMX versions:
- **New Script**: `python/update-docs-deps.py`
- Fetches latest OMMX version from PyPI (or accepts explicit version)
- Updates all `ommx*` dependencies in `docs/pyproject.toml`
- Type-safe implementation with proper assertions
- **Workflow Integration**: `.github/workflows/release_python.yml`
- New `update_docs_deps` job runs after PyPI publish
- Automatically creates PR to update `docs/pyproject.toml`,
`docs/uv.lock`, and `requirements.txt`
- Extracts version from git tag (`python-X.Y.Z`)
- **Task Updates**:
- `task python:update-docs-deps -- <version>`: Update docs dependencies
- `task pip_compile`: Compile requirements.txt (simplified, no
auto-update)
### 3. Cleanup
- Removed `bin/task` from git tracking
- Added `bin/` to `.gitignore` to prevent accidental commits of
downloaded binaries
## Changes
- `.github/workflows/release_python.yml`: Add `update_docs_deps` job
- `python/update-docs-deps.py`: New script for updating docs
dependencies
- `python/Taskfile.yml`: Add `update-docs-deps` task
- `Taskfile.yml`: Simplify `pip_compile` task
- `docs/pyproject.toml`: Updated to OMMX 2.0.9
- `docs/uv.lock`, `requirements.txt`: Regenerated with updated
dependencies
- `docs/en/tutorial/download_qplib_instance.ipynb`: New dedicated QPLIB
tutorial (English)
- `docs/ja/tutorial/download_qplib_instance.ipynb`: New dedicated QPLIB
tutorial (Japanese)
- `docs/en/_toc.yml`: Added QPLIB notebook entry
- `docs/ja/_toc.yml`: Added QPLIB notebook entry
- `.gitignore`: Add `bin/` directory
Fixes #643
<!-- START COPILOT CODING AGENT TIPS -->
---
💬 Share your feedback on Copilot coding agent for the chance to win a
$200 gift card! Click
[here](https://survey3.medallia.com/?EAHeSx-AP01bZqG0Ld9QLQ) to start
the survey.
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: termoshtt <1238153+termoshtt@users.noreply.github.com>
Co-authored-by: Toshiki Teramura <toshiki.teramura@gmail.com>
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Active Branches
No pull requests foundAs pull requests are created, their performance will appear here. © 2025 CodSpeed Technology