Top level readme should be short and concise for more detailed readme present in a dedicated docs site or folder/task level readme.
The structure of top level readme:
- Intro to xyne-play - What's it for, why is it useful
- Installation
- Usage patterns - Pythonic / Cmdline
- Example 1 - fine tuning LLM -
- Find more examples [link]
The structure of task level readme:
- Intro to the task, and what it does
- The expected dataset format
- Training command on toy dataset
- How to use custom config or override partially
Top level readme should be short and concise for more detailed readme present in a dedicated docs site or folder/task level readme.
The structure of top level readme:
The structure of task level readme: