Repository navigation
Improve model readme md templates #2
Description
Some to-dos:
- Add more information about
src-d/modelforge's workings and relationship w/ the models. - Add file size information.
- Add more structure to the descriptions.
- Add more information about the process of training the models, a more detailed overview, etc
Example that could be used as a template (more suggestions welcome), being more structured and informative: https://nlp.stanford.edu/projects/glove/
Activity
[-]Improve model README templates[/-][+]Improve model readme md templates[/+]marnovo commentedon Oct 16, 2017
@EgorBu feel free to add suggestions (and help, heh).
vmarkovtsev commentedon Oct 16, 2017
@marnovo What is more structure in the descriptions?
The process of training the models is deprecated and does not use UAST and Babelfish for example. In fact, they are hacky converted proof-of-concept models which only demonstrate that "something works" without any guarantee of the quality. I feel that I should not explain the bloody hell which born them.
marnovo commentedon Oct 16, 2017
Sorry, being more specific: structure = organize the descriptions setting headings, lists with the content elements to make it easier to consume the information and to navigate/compare models.
r0mainK commentedon Jul 6, 2018
@marnovo is this still relevant or ?
marnovo commentedon Jul 8, 2018
@r0mainK yes—it marginally improved from the baseline, but still light years behind the benchmark.
However, we might want to hold off a bit before working on this, given the discussion over this proposal.