-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Fixed options dublicate in documentation for EmbeddingInitializerField #4022
Fixed options dublicate in documentation for EmbeddingInitializerField #4022
Conversation
Unit Test Results 6 files ±0 6 suites ±0 13m 41s ⏱️ -46s Results for commit f877f75. ± Comparison against base commit 341a8bc. This pull request skips 2 tests.
|
@mhabedank Hi! Thank you for looking into this issue. Could you please point out what the duplication issue actually is? By reading the documentation, I am seeing the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Requesting a clarification.
Here in category features encoding section: https://ludwig.ai/latest/configuration/features/category_features/#encoders |
@mhabedank I see -- thank you very much for highlighting. Ideally, the solution would be the one that also includes the "(default: null)" part (with everything being the same). Does your fix make it so? Thank you. |
The default part is not part of the issue. The green marked part should be gone. That's the part generated within the dataclass field in the Ludwig repo. |
@mhabedank Got it. Does your fix properly delete the green part, without causing problems in other parts of the documentation? Thank you. |
|
🙇 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Thank you very much, @mhabedank
The options for the EmbeddingInitializerField are displayed twice in the documentation.
This is due to the fact that both the field in the Ludwig repro and the build logic in the documentation append the options list to the description string in this particular case.
The problem has been solved by removing this logic from the field. The documentation takes over the task of appending this information.
See issue in documentation repo.
There should be a discussion about what the right path is. At the moment, different fields handle the task differently. Sometimes the documentation is supposed to assemble the string, sometimes the field does it itself.