Skip to content

version bump 3.0.1 - #3423

Merged
deruyter92 merged 2 commits into
mainfrom
release/version_3_0_1
Jul 23, 2026
Merged

version bump 3.0.1#3423
deruyter92 merged 2 commits into
mainfrom
release/version_3_0_1

Conversation

@deruyter92

@deruyter92 deruyter92 commented Jul 20, 2026

Copy link
Copy Markdown
Collaborator

This PR should consolidate the new version before release, and can be merged after merging the following PRs that should be included:

See draft changelog below:

DeepLabCut 3.0.1 - a stability release with a major documentation overhaul and a new structured configuration system.

Highlights

  • Comprehensive documentation audit — The user guide has been thoroughly reviewed, updated, and improved. Please check out:

    • Our updated user guide, which is restructured for better readability and updated to reflect the latest API and features.
    • Our brand-new developer documentation site, which provides full API references, architecture guides, and developer onboarding material.
  • Structured & validated configurations — The config system has been migrated to typed Pydantic models. Existing config.yaml files remain fully compatible, but configs are now schema-validated on load with clear error messages for invalid entries. Some user-benefits include:

    • ProjectConfig: load and save your config.yaml with full schema validation — typos, wrong types, or invalid values are caught immediately with clear error messages.
    • Pretty-printing: call cfg.print() or pretty_print(cfg) to inspect any config in a readable tree.
    • Change-tracking: DLCVersionedConfig tracks which fields have been modified since the config was loaded from YAML, so when saving back to disk, log_changes() can report exactly what was changed.
    • Dict-like compatibility: existing code that accesses config keys like a dict still works.
    • Auto-aliasing of old field names: renamed keys are silently mapped, so older config files load without manual edits.

Summarized Changelog

Full Changelog: v3.0.0...v3.0.1

@deruyter92
deruyter92 force-pushed the jaap/update-deprecation-markers branch 2 times, most recently from add1845 to 30c469d Compare July 21, 2026 06:49
Base automatically changed from jaap/update-deprecation-markers to main July 21, 2026 08:01
@deruyter92
deruyter92 force-pushed the release/version_3_0_1 branch from 71020f3 to a652792 Compare July 21, 2026 16:39
@deruyter92
deruyter92 marked this pull request as ready for review July 21, 2026 16:41
@deruyter92
deruyter92 requested review from AlexEMG and MMathisLab July 21, 2026 16:42
@deruyter92 deruyter92 added the versioning Related to project’s version number, release identifiers, version metadata label Jul 21, 2026
@deruyter92
deruyter92 merged commit 2df0f46 into main Jul 23, 2026
32 checks passed
@deruyter92
deruyter92 deleted the release/version_3_0_1 branch July 23, 2026 11:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

versioning Related to project’s version number, release identifiers, version metadata

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants