Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Restrict docling library versions to resolve dependency issues + update mypy linting packages (backport #434) #437

Merged
merged 1 commit into from
Dec 10, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Dec 10, 2024

docling-parse is automatically pulled in by docling as a dependency, and v3.0.0 of docling-parse contains breaking syntax changes that prevent our e2e builds in instructlab from succeeding. See issue in InstructLab here: instructlab/instructlab#2765

For now, we will pin docling-parse to the latest v2 release while we investigate how we can update the docling-parse syntax to use the new v3 syntax. We will also pin to docling<=2.8.3 because v2.10.0 was updated to use docling-parse>=3.0.0. See here: https://github.com/DS4SD/docling/releases/tag/v2.10.0 (Docling-parse v2 as default PDF backend)

Finally, mypy is experiencing issues with a breaking upstream change, too. By default, mypy pulls in the latest version of pydantic, which is unfortunately now incompatible with mypy as of its v2.10 release. See:

To workaround this dependency issue, I pinned the related dependency, pydantic, to <=v2.9.2 in our tox.ini file. This will force our latest mypy to use a compatible pydantic. However, note that I did also pin mypy>=1.0,<1.14. I did this as a safety measure for when the mypy maintainers inevitably fix the issue in v1.14 or later.


This is an automatic backport of pull request #434 done by Mergify.

@mergify mergify bot added the conflicts label Dec 10, 2024
Copy link
Contributor Author

mergify bot commented Dec 10, 2024

Cherry-pick of 2e00bb8 has failed:

On branch mergify/bp/release-v0.6/pr-434
Your branch is up to date with 'origin/release-v0.6'.

You are currently cherry-picking commit 2e00bb8.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	new file:   CHANGELOG.md

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both added:      .github/workflows/actionlint.yml
	both added:      .github/workflows/docs.yml
	both added:      .github/workflows/e2e-nvidia-l4-x1.yml
	both added:      .github/workflows/e2e-nvidia-l40s-x4.yml
	both added:      .github/workflows/e2e-nvidia-t4-x1.yml
	both added:      .github/workflows/lint.yml
	both added:      .github/workflows/pypi.yaml
	both added:      .github/workflows/spellcheck.yml
	both added:      .github/workflows/stale_bot.yml
	both added:      .github/workflows/test.yml
	both added:      .spellcheck-en-custom.txt
	both added:      README.md
	both added:      requirements-dev.txt
	both added:      requirements.txt
	both added:      src/instructlab/sdg/generate_data.py
	both added:      src/instructlab/sdg/utils/json.py
	both added:      tox.ini

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@mergify mergify bot added CI/CD Affects CI/CD configuration documentation Improvements or additions to documentation testing Relates to testing release-branch ci-failure dependencies Pull requests that update a dependency file labels Dec 10, 2024
@jaideepr97
Copy link
Member

@Mergifyio rebase

Copy link
Contributor Author

mergify bot commented Dec 10, 2024

rebase

☑️ Nothing to do

  • any of:
    • #commits > 1 [📌 rebase requirement]
    • #commits-behind > 0 [📌 rebase requirement]
    • -linear-history [📌 rebase requirement]
  • -closed [📌 rebase requirement]
  • -conflict [📌 rebase requirement]
  • queue-position = -1 [📌 rebase requirement]

@bbrowning bbrowning force-pushed the mergify/bp/release-v0.6/pr-434 branch from f159971 to 9e29731 Compare December 10, 2024 15:23
@bbrowning
Copy link
Contributor

@Mergifyio rebase

`docling-parse` v3.0.0 contains breaking changes to the syntax, which is currently breaking our builds.

Also, `mypy` < v1.14  pulls in the latest version of `pydantic` by default, so this commimt hardcodes the correct span of `pydantic` versions that are compatible with `mypy` < v1.14

Finally, we want to pin `docling[tesserocr]>=2.4.2,<=2.8.3` due to breaking changes in v2.9.0 on 9 Dec 2024.

Signed-off-by: Courtney Pacheco <[email protected]>
Copy link
Contributor Author

mergify bot commented Dec 10, 2024

rebase

✅ Branch has been successfully rebased

@bbrowning bbrowning force-pushed the mergify/bp/release-v0.6/pr-434 branch from 9e29731 to 4bf63b9 Compare December 10, 2024 15:34
@mergify mergify bot removed the ci-failure label Dec 10, 2024
@bbrowning
Copy link
Contributor

@courtneypacheco I had to manually cherry-pick this on top of what mergify created - can you verify the changes look good?

@courtneypacheco
Copy link
Contributor

Yes, the changes look good. Thank you!

@bbrowning bbrowning merged commit 8e13b1c into release-v0.6 Dec 10, 2024
22 checks passed
@bbrowning
Copy link
Contributor

Merged - thanks for the review!

@bbrowning bbrowning deleted the mergify/bp/release-v0.6/pr-434 branch December 10, 2024 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD Affects CI/CD configuration conflicts dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation release-branch testing Relates to testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants