Skip to content

Commit

Permalink
docs: add docstring for load_model_managers
Browse files Browse the repository at this point in the history
  • Loading branch information
tazlin committed Jan 9, 2024
1 parent df98872 commit 5662e10
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions hordelib/shared_model_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,21 @@ def load_model_managers(
download_legacy_references: bool = True,
overwrite_existing_references: bool = True,
):
"""Load the model managers specified.
Args:
managers_to_load (Iterable[str | MODEL_CATEGORY_NAMES | type[BaseModelManager]], optional): \
The model managers to load. \
Defaults to ALL_MODEL_MANAGER_TYPES.
multiprocessing_lock (multiprocessing_lock | None, optional): If you are using multiprocessing, \
you should pass a lock here. \
Defaults to None.
download_legacy_references (bool, optional): If True, this will download all legacy model references. \
Defaults to True.
overwrite_existing_references (bool, optional): If True, this will overwrite any existing legacy model \
references that might be already downloaded. \
Defaults to True.
"""
if cls.manager is None:
cls.manager = ModelManager()

Expand Down

0 comments on commit 5662e10

Please sign in to comment.