Skip to content

docs: correct docstrings that describe the wrong parameters - #627

Merged
mkumar73 merged 4 commits into
OpenTabular:mainfrom
jorisstrakeljahn:docs/docstrings-match-code
Nov 14, 2026
Merged

mkumar73 merged 4 commits into
OpenTabular:mainfrom
jorisstrakeljahn:docs/docstrings-match-code

Conversation

@jorisstrakeljahn

Copy link
Copy Markdown
Contributor

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:

  1. The Mambular, MambaTab and MambAttention configs describe dt_rank, dt_scale, dt_init, dt_min, dt_max and dt_init_floor as 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.
  2. There are eleven architectures where cat_feature_info and num_feature_info are described as parameters, and most of them also as attributes. But the constructors take feature_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.
  3. And last but not least, three config docstrings link to deeptab.configs.trainer_config.TrainerConfig, two of them also to deeptab.configs.preprocessing_config.PreprocessingConfig. These modules do not exist anymore, so with this PR the links point to deeptab.configs. Also ModernNCAConfig and TabRConfig give "ple" as an example embedding_type, but EmbeddingLayer only accepts "linear", "ndt" and "plr". TromptConfig describes P as the number of steps, but it is the number of prompts. The ResNet ResidualBlock documents norm_layer instead of norm.

just docs passes.
It only covers the config docstrings, because the architecture and block docstrings are not in the API reference.
just test: 3355 passed.
just check passes.

@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@mkumar73 mkumar73 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jorisstrakeljahn,

  • docstring corrections accurately reflect the implementation, with no executable-code changes.
  • All CI checks pass.
  • PR approved

thank you for your contribution :)

@mkumar73
mkumar73 merged commit 327dfeb into OpenTabular:main Nov 14, 2026
35 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants