search

whittle-org / whittle

Python library to compress LitGPT models for resource efficient inference.
https://whittle-org.github.io/whittle/latest/
Apache License 2.0
10 stars 4 forks source link

Update doc strings #164

Open rheasukthanker opened 1 week ago

rheasukthanker commented 1 week ago

Is your feature request related to a problem? Please describe. Could we add doc strings to functions which are missing doc strings eg: https://github.com/whittle-org/whittle/blob/main/whittle/models/gpt/extract.py#L13. Ideally it would be nice to add docstrings to all main functions to improve documentation for the library.

timurcarstensen commented 1 week ago

One take on this: generally, yes. However, not if the function is very descriptive in what it does. I would leave this up to the contributor and then catch it in code review :)

timurcarstensen commented 6 days ago

Also: the docstring format is not consistent across the codebase. For example, in whittle/search/local_search.py has a different format than what we use elsewhere

snikhil24 commented 4 days ago

I’d like to work on this issue. Please let me know if there’s a preferred format or any specific guidelines!