Closed rafaelmds closed 3 years ago
Currently we mention some example in section 3.4. Examples.
I think we should remove this subsection and link to the benchmark or examples sections.
Also, currently there's only examples. Shall we better differentiate benchmark/example?
@rafaelmds ... for now, you only add information about benchmark. Are you planning to add the section on the examples?
So, I think we need to move 3.4. Examples to a dedicated section (it will be section 7 after 6 Benchmarks). Then update Benchmarks to reflect the new structure.
You suggested to
create a README file, which explains how to run and create the models in each models folder.
which I think is covered by your PR #25 (for example this README.md)
So, I think we need to move 3.4. Examples to a dedicated section (it will be section 7 after 6 Benchmarks). Then update Benchmarks to reflect the new structure.
You suggested to
create a README file, which explains how to run and create the models in each models folder.
which I think is covered by your PR #25 (for example this README.md)
@rafaelmds, you are right! If we maintain the README files for the examples, it is not necessary to add more information. So, in section 3.4 we can write that to run the examples, you need to follow the instructions that appear in the README. What do you think?
Improve documentation to better present the examples and how to run them.
Fixes #23