Fixed options dublicate in documentation for EmbeddingInitializerField

[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.

[github-actions]

Unit Test Results

  6 files  ±0    6 suites  ±0   13m 41s ⏱️ -46s
12 tests ±0    7 ✔️  -   2    5 💤 +  2  0 ❌ ±0 
60 runs  ±0  30 ✔️  - 12  30 💤 +12  0 ❌ ±0 

Results for commit f877f75. ± Comparison against base commit 341a8bc.

This pull request skips 2 tests.

tests.regression_tests.benchmark.test_model_performance ‑ test_performance[ames_housing.gbm.yaml]
tests.regression_tests.benchmark.test_model_performance ‑ test_performance[mercedes_benz_greener.gbm.yaml]

[alexsherstinsky]

@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 embedding_initializer included in different encoder documentation pages that use it. Perhaps you could provide screenshot of the documentation and highlight the duplication you are seeing? Thank you for helping to clarify your observation.

[alexsherstinsky]

Requesting a clarification.

[mhabedank]

Here in category features encoding section: https://ludwig.ai/latest/configuration/features/category_features/#encoders

[alexsherstinsky]

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.

[mhabedank]

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.

[alexsherstinsky]

The default part is not part of the issue. The green marked part should be gone.

@mhabedank Got it. Does your fix properly delete the green part, without causing problems in other parts of the documentation? Thank you.

[mhabedank]

EmbeddingInitializerField is only used in two places within the category feature. To the best of my knowledge, I cannot see a problem.

[alexsherstinsky]

EmbeddingInitializerField is only used in two places within the category feature. To the best of my knowledge, I cannot see a problem.

🙇

[alexsherstinsky]

LGTM! Thank you very much, @mhabedank