chore(api): add type annotations to LLM class and module-level functions#2241
Open
Koushik-Salammagari wants to merge 1 commit into
Open
chore(api): add type annotations to LLM class and module-level functions#2241Koushik-Salammagari wants to merge 1 commit into
Koushik-Salammagari wants to merge 1 commit into
Conversation
This file contains hidden or 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
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.
What does this PR do?
Adds missing Python 3.10+ style type annotations to
litgpt/api.py.api.pyhad the most unannotated functions of any non-utils.pyfile in the codebase (11 functions), and also contained several implicit-Optionalsignatures that mypy flags as errors.Changes
LLM.__init__preprocessor: "Preprocessor | None" = NoneLLM.__init__prompt_style: PromptStyle | None = NoneLLM.__init__devices: int | list[int] | None = NoneLLM.__init__config: Config | None = NoneLLM.__init__checkpoint_dir: Path | None = NoneLLM.__init__fabric: L.Fabric | None = NoneLLM.tokenizerproperty-> TokenizerLLM.state_dictdestination: dict | None,prefix: str,keep_vars: bool,-> dictLLM.load_state_dictstate_dict: dict,strict: bool,-> AnyLLM.benchmarknum_iterations: int,**kwargs: Any,-> tuple[str, dict]calculate_number_of_devicesdevices: int | list[int],-> intbenchmark_dict_to_markdown_tabledata: dict,-> strThe
preprocessorparameter uses a forward reference string ("Preprocessor | None") becausePreprocessoris defined later in the same file.No new imports needed —
Anywas already imported fromtyping.Before submitting