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

Generic reports #377

Merged
merged 6 commits into from
Jun 4, 2024
Merged

Generic reports #377

merged 6 commits into from
Jun 4, 2024

Conversation

bkorycki
Copy link
Contributor

A possibly wild stab at generating generic reports. content/ now contains all of the generic/default .toml files, and values in the new content_mlc/ directory will override the defaults if --generic-report is not provided.
Just want to confirm that this is generally how we want generic reports to work, and then I’ll add the CSS stuff.

@bkorycki bkorycki requested review from wpietri and dhosterman May 24, 2024 16:22
@bkorycki bkorycki requested a review from a team as a code owner May 24, 2024 16:22
Copy link

github-actions bot commented May 24, 2024

MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅

src/modelbench/run.py Outdated Show resolved Hide resolved
"--custom-branding",
type=click.Path(file_okay=False, dir_okay=True, path_type=pathlib.Path),
help="Path to custom branding. Implicitly sets --generic-report to remove MLCommons copy.",
)
@click.option(
Copy link
Collaborator

Choose a reason for hiding this comment

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

Would it make more sense here to just have one CLI option that is either 1) --custom-branding which includes MLC branded stuff or 2) no --custom-branding which is always generic?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Wouldn't users need to know the path of MLC branding in that case?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think for now the only users running reports with MLC branding will be the three of us. And we'll eventually put that branding directory in modellab, where we'll be running the official reports from.

Copy link
Contributor

@wpietri wpietri left a comment

Choose a reason for hiding this comment

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

Yes, I like where you're going with this, but agree with Daniel. The default should be a generic report. Then something like a --branding option lets us point to something like a folder that contains our flavor packet. In a future pull request, we'll move that folder-or-whatever to ModelLab, but this PR just needs to start extracting it.

@bkorycki
Copy link
Contributor Author

Okay, updated to remove --generic and make generic default. To get a report with MLC branding, you now need to use --custom-branding src/modelbench/templates/content_mlc (if you're at the root level)

@bkorycki bkorycki requested a review from dhosterman May 29, 2024 20:35
Copy link
Collaborator

@dhosterman dhosterman left a comment

Choose a reason for hiding this comment

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

Looks good to me! Sorry it took so long for me to review!

@bkorycki bkorycki merged commit c4c6368 into main Jun 4, 2024
4 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Jun 4, 2024
@wpietri wpietri deleted the generic-report branch September 30, 2024 12:44
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants