Rename report to examples_compatibility_report.html#942
Conversation
DingmaomaoBJTU
left a comment
DingmaomaoBJTU
left a comment
There was a problem hiding this comment.
Overall this rename is clean and consistent across all touched files. Three minor issues to note:
-
Module docstring not updated (download_report.py line 5): The top-level docstring still reads 'Fetch the model compatibility report' — it was not updated in this PR while every other reference was.
-
Link text vs. filename/page title mismatch (dev/reference/supported-models/index.html): The visible link text was changed to 'models accuracy report' but the target filename contains 'examples_compatibility' and the HTML title/h1 reads 'Model Accuracy Report'. Consider aligning these three strings.
-
Deployment coordination: SOURCE_FILE in download_report.py now points to 'e2e_model_coverage_result/examples_compatibility_report.html' in the private gim-home/ModelKitArtifacts repo. The download script will fail until that repo is updated to generate the new filename — worth confirming this is coordinated.
-
HTML title mismatch (examples_compatibility_report.html line 6): The HTML title tag reads 'Model Accuracy Report' while the filename is examples_compatibility_report.html. If the title is intentional (emphasising accuracy), the filename should match; if the filename is dictated by the private repo generator, the title should align to it.
| <p>Windows ML CLI has validated a set of models for compatibility across all | ||
| Execution Providers (EPs)—see the full | ||
| <a href="https://microsoft.github.io/winml-cli/reports/model_compatibility_report.html">model compatibility report</a>.</p> | ||
| <a href="https://microsoft.github.io/winml-cli/reports/examples_compatibility_report.html">models accuracy report</a>.</p> |
There was a problem hiding this comment.
Visible link text changed to 'models accuracy report', but the target filename is examples_compatibility_report.html and the page h1 reads 'Model Accuracy Report'. These three strings don't align — consider either matching the filename ('examples compatibility report') or the HTML title ('Model Accuracy Report').
|
|
||
| By default the report is written next to this script, overwriting the published | ||
| copy (reports/model_compatibility_report.html on the gh-pages branch). | ||
| copy (reports/examples_compatibility_report.html on the gh-pages branch). |
There was a problem hiding this comment.
The module-level docstring at line 5 still says 'Fetch the model compatibility report from gim-home/ModelKitArtifacts.' — it was not updated in this PR. Worth aligning it with the rename.
… naming - Fix module docstring in download_report.py (was still 'model compatibility report') - Standardize display name to 'Model Accuracy Report' across docstring, README, argparse, and docs link to match the report page title - Update SOURCE_FILE and all references to model_accuracy_report.html - Update dev search index entry for consistency
2 participants
No description provided.