Add ECD Descriptions #2897
Merged
Add ECD Descriptions #2897
Conversation
This file contains 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
for more information, see https://pre-commit.ci
…to descriptions
for more information, see https://pre-commit.ci
…to descriptions
for more information, see https://pre-commit.ci
|
Actually going to make a small change here where I put the descriptions in the metadata so I can also maintain relevant links. |
tgaddair
approved these changes
Jan 5, 2023
|
Hey @connor-mccorm , nice work getting this into Ludwig so quickly! One callout: some of these descriptions seems really long and not particularly helpful in teaching people why they would choose a particular encoder/decoder/combiner. Can we add one sentence to the beginning of each description explaining when/why to use each option? |
…to descriptions
for more information, see https://pre-commit.ci
…to descriptions
for more information, see https://pre-commit.ci
…to descriptions
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
…to descriptions
for more information, see https://pre-commit.ci
…to descriptions
for more information, see https://pre-commit.ci
…to descriptions
for more information, see https://pre-commit.ci
…to descriptions
for more information, see https://pre-commit.ci
justinxzhao
approved these changes
Jan 11, 2023
dantreiman
reviewed
Jan 11, 2023
dantreiman
requested changes
Jan 11, 2023
dantreiman
reviewed
Jan 11, 2023
dantreiman
reviewed
Jan 11, 2023
dantreiman
reviewed
Jan 11, 2023
dantreiman
reviewed
Jan 11, 2023
dantreiman
reviewed
Jan 11, 2023
Co-authored-by: Daniel Treiman <dan.treiman@gmail.com>
for more information, see https://pre-commit.ci
dantreiman
approved these changes
Jan 11, 2023
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.
Adds specific descriptions for each encoder, combiner, and decoder. I added a short and a long description - short description for UI display, long description for in depth documentation. I have put these descriptions on the metadata so the type parameter under the schema classes now reference the metadata for those descriptions. Lastly, I have added the descriptions on the json_schema_mapping so that it can be accessed from the schema for each different encoder/combiner/decoder.