Add Doc Strings to Config Files #465
Conversation
ParagEkbote
changed the title
| @@ -47,6 +47,14 @@ def divide_chunks(array, n): | |||
|
|
|||
| @dataclass | |||
| class TGIModelConfig: | |||
| """ | |||
| This class provides a streamlined configuration for integrating with Text Generation Inference (TGI) endpoints. | |||
There was a problem hiding this comment.
Add a link to the doc of TGI, remove "This class"
| This class provides a streamlined configuration for integrating with Text Generation Inference (TGI) endpoints. | ||
| Attributes: | ||
| inference_server_address (str, required): The endpoint address of the inference server hosting the model. |
| @@ -58,7 +62,19 @@ def init_configs(self, env_config: EnvConfig): | |||
|
|
|||
|
|
|||
| class AdapterModel(BaseModel): | |||
| """ | |||
| This class is designed to integrate adapter models with a pre-trained base model. | |||
| @@ -71,7 +87,15 @@ def _create_auto_tokenizer(self, config: AdapterModelConfig, env_config: EnvConf | |||
| ) | |||
|
|
|||
| def _create_auto_model(self, config: AdapterModelConfig, env_config: EnvConfig) -> AutoModelForCausalLM: | |||
| """Returns a PeftModel from a base model and a version fined tuned using PEFT.""" | |||
| """ | |||
| It returns a PeftModel from a base model and a version fined tuned using PEFT. | |||
…gEkbote/lighteval into Document-Custom-Model-Files
Co-authored-by: Clémentine Fourrier <[email protected]>
…gEkbote/lighteval into Document-Custom-Model-Files
Co-authored-by: Nathan Habib <[email protected]>
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
There was a problem hiding this comment.
The syntax of the docstrings is not right. Please note, that the docstring parser is very strict with the syntax conventions: tabs, colons, parentheses,...
You have the syntax examples in the docs-builder repo: https://github.com/huggingface/doc-builder
Also the formatter raises errors: please run make style to align with the linter/formatter conventions.
…gEkbote/lighteval into Document-Custom-Model-Files
|
I will update this PR as draft to fix the syntax errors and update the docstrings correctly as mentioned before. cc: @albertvillanova |
As discussed in #247, I've added docstrings to the config class of the required files and updated some of them for enhanced clarity.
Please let me know if any further corrections are needed and I will make the necessary changes.
partially fixes #247
cc: @clefourrier