Skip to content

Commit

Permalink
improved docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
jmercat committed Jan 9, 2025
1 parent 1c21b08 commit 3aa4298
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
3 changes: 2 additions & 1 deletion database/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,7 @@ def get_or_add_model_by_name(model: str, model_source: str = "hf"):
Args:
model (str): The path or identifier for the Hugging Face or other model.
model_source (str): Source of the model (as model arg in lm_eval or eval.py)
"""
if model_source == "hf":
git_commit_hash = HfApi().model_info(model).sha
Expand Down Expand Up @@ -384,7 +385,7 @@ def register_model_to_db(model_name: str, model_source: str) -> UUID:
Args:
model_name (str): The name or identifier for the model
model_source (str): Source of the model (e.g., 'openai-chat-completions', 'anthropic')
model_source (str): Source of the model (e.g., 'openai-chat-completions' or other model arg in lm_eval)
Returns:
UUID: The unique identifier assigned to the registered model
Expand Down
3 changes: 2 additions & 1 deletion eval/eval_tracker.py
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@ def get_or_create_model(
Args:
model_name: Name of the model
model_id: Optional UUID of existing model
model_source: Source of the model (as model arg in lm_eval or eval.py)
Returns:
Tuple of (model_id, dataset_id)
Expand Down Expand Up @@ -347,7 +348,7 @@ def update_evalresults_db(
Args:
eval_log_dict: Dictionary containing evaluation logs and results
model_id: Optional UUID of the model
model_source: Source of the model (similar to the model arg in eval.py)
model_source: Source of the model (similar to the model arg in lm_eval or eval.py)
model_name: Optional name of the model
creation_location: Location where evaluation was run
created_by: Username who ran the evaluation
Expand Down

0 comments on commit 3aa4298

Please sign in to comment.