Documentation and typing of functions #5
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
clefourrier
requested changes
Jan 31, 2024
There was a problem hiding this comment.
2 important style things:
- Remove all the
Theat the start of arg docstrings. It makes them heavier to read.
Ex: instead ofThe revision of the model, useModel revision (commit hash). - Follow the ref doc for optional items (try to be homogeneous)
One comment:
- Try to add and explain the small edge cases in the doc - why are we asking for the non obvious params? what happens when a param is None? Etc.
src/lighteval/models/model_config.py
Outdated
| Base configuration class for models. | ||
|
|
||
| Attributes: | ||
| pretrained (str): The HuggingFace Hub model ID name or the path to a |
There was a problem hiding this comment.
- Remove all the
Theat the start of arg docstrings.
Ex: instead ofThe revision of the model, useModel revision (commit hash) to use for evaluation. - Follow the ref doc for optional items
- When an item is optional, don't forget to add it in the arg description. For example, for quantization config, you can add an "if needed" for ex.
| name (str): The name of the task. | ||
| cfg (dict): The configuration dictionary containing | ||
| task-specific settings (from the task_table.json file). | ||
| cache_dir (Optional[str], optional): The directory to cache the |
There was a problem hiding this comment.
What happens if the cache_dir is None
There was a problem hiding this comment.
cache dir is not used in the class. When loading the dataset, we manually set ache_dir to None
There was a problem hiding this comment.
We could remove it I guess :)
Co-authored-by: Clémentine Fourrier <[email protected]>
Co-authored-by: Clémentine Fourrier <[email protected]>
…into nathan-update-doc
clefourrier
previously approved these changes
Feb 6, 2024
clefourrier
approved these changes
Feb 6, 2024
| `pretrained_model_name_or_path` argument of `from_pretrained` in the | ||
| HuggingFace `transformers` API. | ||
| accelerator (Accelerator): accelerator to use for model training. | ||
| tokenizer (Optional[str]): HuggingFace Hub tokenizer ID that will be |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.