Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support custom results/details push to hub #457

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions src/lighteval/logging/evaluation_tracker.py
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,28 @@ def __init__(

self.public = public

@property
def results(self):
config_general = asdict(self.general_config_logger)
# We remove the config from logging, which contains context/accelerator objects
config_general.pop("config")
results = {
"config_general": config_general,
"results": self.metrics_logger.metric_aggregated,
"versions": self.versions_logger.versions,
"config_tasks": self.task_config_logger.tasks_configs,
"summary_tasks": self.details_logger.compiled_details,
"summary_general": asdict(self.details_logger.compiled_details_over_all_tasks),
}
return results

@property
def details(self):
return {
task_name: [asdict(detail) for detail in task_details]
for task_name, task_details in self.details_logger.details.items()
}

def save(self) -> None:
"""Saves the experiment information and results to files, and to the hub if requested."""
logger.info("Saving experiment tracker")
Expand Down Expand Up @@ -281,6 +303,31 @@ def push_to_hub(

self.recreate_metadata_card(repo_id)

def push_results_to_hub(self, repo_id: str, path_in_repo: str, private: bool | None = None):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add some doc, especially to explain the mechanism for the args you added (as they over-write some defaults set at the class level).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Edit: just saw they were in your todo :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't repo_id be results by default ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same for path_in_repo - do we want to follow as default what we had? (org/modelname/results_date.json)

repo_id = repo_id if "/" in repo_id else f"{self.hub_results_org}/{repo_id}"
private = private if private is not None else not self.public
self.api.create_repo(repo_id, private=private, repo_type="dataset", exist_ok=True)
results_json = json.dumps(self.results, cls=EnhancedJSONEncoder, indent=2, ensure_ascii=False)
self.api.upload_file(
repo_id=repo_id,
path_or_fileobj=results_json.encode(),
path_in_repo=path_in_repo,
repo_type="dataset",
)

def push_details_to_hub(self, repo_id: str, path_in_repo: str, private: bool | None = None):
repo_id = repo_id if "/" in repo_id else f"{self.hub_results_org}/{repo_id}"
private = private if private is not None else not self.public
self.api.create_repo(repo_id, private=private, repo_type="dataset", exist_ok=True)
for task_name, details in self.details:
details_json = "\n".join([json.dumps(detail) for detail in details])
self.api.upload_file(
repo_id=repo_id,
path_or_fileobj=details_json.encode(),
path_in_repo=path_in_repo.format(task_name=task_name),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you provide an example of the expected path_in_repo ?

repo_type="dataset",
)

def recreate_metadata_card(self, repo_id: str) -> None: # noqa: C901
"""Fully updates the details repository metadata card for the currently evaluated model

Expand Down
Loading