Update function signatures - #3458
Draft
deruyter92 wants to merge 3 commits into
Draft
Conversation
deruyter92
changed the base branch from
jaap/prepare_tf_deprecation
to
jaap/lazy-loading
August 21, 2026 08:58
Apply a new parameter-aliasing deprecation round (since 3.0.2) to the public API, GUI, and internals: add @renamed_parameter markers and update signatures, docstrings, and call sites for parameters that still used legacy camelCase or concatenated names (e.g. outlieralgorithm -> outlier_algorithm, filtertype -> filter_type, trainFraction -> train_fraction). Update tests for the new names.
deruyter92
force-pushed
the
jaap/update-function-signatures
branch
from
August 26, 2026 11:34
ced1b85 to
16312b9
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Motivation
The DeepLabCut API was recently streamlined in #3332 and #3198, which introduced consistent paramteter names (e.g. snake case, lowercase internally consistent parameter names). However several function signatures currently still remain to be normalized.
This PR aims to further streamline all function signatures of all API to normalize
config_path: str,config: str-->config: ProjectConfig | str | Path | dictShuffles-->shufflesTrainFraction-->train_fractionetcetera.
Note
This PR is a placeholder that currently has draft status. I am still considering a smaller scope and the specific renames remain to be discussed and tested properly.