Issue #141

[sinanshamsudheen]

📋 PR Summary - Add Description Field Support for Scripts

�� Issue Addressed

Closes #141 - "Can we have a description field in the metadata of a script?"

✨ New Features

• mlc describe script --tags=<tags> - Quick description lookup
• Enhanced mlc show script - Now displays description field when present
• Graceful fallback - Shows "No description available" for missing descriptions

🔧 Implementation Details

• Added describe() method to ScriptAction class
• Updated show() method to include description in metadata display
• Registered describe action in CLI parser
• Updated documentation across all relevant files

📁 Files Changed

• mlc/script_action.py - Core implementation (+40 lines)
• mlc/main.py - CLI registration (+1 action)
• README.md - Updated action table
• docs/targets/script/index.md - Added documentation

✅ Testing

• ✅ Tested with real MLPerf repository
• ✅ Verified help system integration
• ✅ Confirmed backward compatibility
• ✅ Tested multiple script scenarios

�� Benefits

• Minimal changes - Only 4 files modified
• Consistent pattern - Follows existing find vs show relationship
• User-friendly - Quick access to script descriptions
• Extensible - Easy to add descriptions to any script's meta.yaml

📊 Stats

• 4 files changed
• 57 insertions, 8 deletions
• Zero breaking changes
• Fully backward compatible

[github-actions]

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

[anandhu-eng]

Hi @sinanshamsudheen , thanks for the PR.

I think we could eliminate the describe action from MLCFlow and include it with show action.

[arjunsuresh]

Thank you @sinanshamsudheen for the PR. As Anandhu told it makes sense for the description to be part of the show action but the describe action looks harmless. Please fill in the CLA form and then we can merge the PR.

[anandhu-eng]

Merging the PR as CLA is approved