Repository navigation
docs: correct docstrings that describe the wrong parameters - #627
Merged
mkumar73 merged 4 commits intoNov 14, 2026
Merged
Conversation
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
mkumar73
approved these changes
Nov 14, 2026
mkumar73
left a comment
Collaborator
There was a problem hiding this comment.
- docstring corrections accurately reflect the implementation, with no executable-code changes.
- All CI checks pass.
- PR approved
thank you for your contribution :)
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
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.
Some docstrings describe parameters that do not exist or describe the wrong thing. This PR corrects them. So only docstrings and one comment change, no code.
Also there are three commits, one for each kind of error:
dt_rank,dt_scale,dt_init,dt_min,dt_maxanddt_init_flooras settings of a decision tree, but these models have no decision tree. The Mamba block docstrings call the same arguments dynamic time components. I used that wording, so the configs and the blocks say the same, but I think "time step" would be more precise. I can change both if you prefer that, but first I wanted to stay close to the wording the project uses right now.cat_feature_infoandnum_feature_infoare described as parameters, and most of them also as attributes. But the constructors takefeature_information, and the classes do not store the two names. So I used the description that TabR, TabM, TabulaRNN, Trompt and ModernNCA already have. Also in Mambular, a comment listed the tuple in the wrong order. I changed that too.deeptab.configs.trainer_config.TrainerConfig, two of them also todeeptab.configs.preprocessing_config.PreprocessingConfig. These modules do not exist anymore, so with this PR the links point todeeptab.configs. AlsoModernNCAConfigandTabRConfiggive "ple" as an exampleembedding_type, butEmbeddingLayeronly accepts "linear", "ndt" and "plr".TromptConfigdescribesPas the number of steps, but it is the number of prompts. The ResNetResidualBlockdocumentsnorm_layerinstead ofnorm.just docspasses.It only covers the config docstrings, because the architecture and block docstrings are not in the API reference.
just test: 3355 passed.just checkpasses.