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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
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:
Summarized Changelog
Full Changelog: v3.0.0...v3.0.1