Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Misleading TabularConfig parameter in Example code #53

Closed
speter00 opened this issue Sep 6, 2023 · 1 comment
Closed

Misleading TabularConfig parameter in Example code #53

speter00 opened this issue Sep 6, 2023 · 1 comment
Assignees
Labels
bug Something isn't working

Comments

@speter00
Copy link

speter00 commented Sep 6, 2023

According to the Example usage in the documentation: https://multimodal-toolkit.readthedocs.io/en/latest/notes/introduction.html
the TabularConfig class has an init parameter called use_num_bn (in the example, it is set to False) for deciding whether to use
Batch Normalization. In the actual TabularConfig class however there is no such parameter, instead there is a numerical_bn parameter with a default value of True. There is also a kwargs parameter.

Right now, if someone follows the example code, they will mistakenly -and probably unknowingly- end up using Batch Normalization, because the use_num_bn parameter will not actually do anything (it will just be absorbed as a kwarg), and instead the default True value of numerical_bn will take effect.

The TabularConfig class's documentation is correct, only the Example section has this mistake. I advise updating the Example code with the numerical_bn parameter instead to avoid misunderstandings.

@akashsaravanan-georgian akashsaravanan-georgian added the bug Something isn't working label Sep 13, 2023
@akashsaravanan-georgian
Copy link
Contributor

Hi @speter00 good catch, thanks for letting us know! We'll make sure to fix this in our next release. Feel free to send a PR if you're interested!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants