Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FT] Docs for the configs #254

Open
RohitMidha23 opened this issue Aug 10, 2024 · 3 comments
Open

[FT] Docs for the configs #254

RohitMidha23 opened this issue Aug 10, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation feature request New feature/request prio

Comments

@RohitMidha23
Copy link
Contributor

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 RohitMidha23 added the feature request New feature/request label Aug 10, 2024
@clefourrier
Copy link
Member

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

@clefourrier clefourrier added documentation Improvements or additions to documentation prio labels Aug 12, 2024
@RohitMidha23
Copy link
Contributor Author

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?

@clefourrier
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation feature request New feature/request prio
Projects
None yet
Development

No branches or pull requests

2 participants