lighteval icon indicating copy to clipboard operation
lighteval copied to clipboard

[FT] Docs for the configs

Open RohitMidha23 opened this issue 1 year ago • 3 comments

Issue encountered

Seems like a lot of features are supported but none of the examples show how best to use them.

Solution/Feature

Even just one sample config file that details all the various features available for use - quantization, env_config, etc, would be greatly helpful.

Posssible alternatives

A more comprehensive document explaining each feature in detail.

RohitMidha23 avatar Aug 10 '24 19:08 RohitMidha23

Yep, we clearly need to add this, thanks for bringing it up!

clefourrier avatar Aug 12 '24 08:08 clefourrier

Can take an initial stab at it since I've gone through the repo recently. Do we want to have a config or have proper docs? What is your recommendation?

RohitMidha23 avatar Aug 12 '24 10:08 RohitMidha23

We have config examples here and you could link them in the doc, and add a small paragraph of explanation in the readme

clefourrier avatar Aug 12 '24 10:08 clefourrier