sambanova / generative_data_prep

Apache License 2.0
58 stars 8 forks source link

ENH - README Structure Reorganization #90

Closed snova-connorm closed 7 months ago

snova-connorm commented 7 months ago

Summary

This PR reorganizes the structure of the README to be more user focused. This PR addresses a few issues I was seeing with customers:

I believe this structure will be a lot more straightforward for customers to digest and get started with. It contains virtually all the same information, just re-ordered/re-structured a bit so it flows better. I have some customers that are willing to read and provide feedback as well. There will probably be some additional tweaks needing to be made here, but overall this should clear things up for the new users a bit.

snova-zoltanc commented 7 months ago

Seriously looks good, the train test eval splits section is much cleaner.

Amazing job 🚀