Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 26, 2025

Motivation

Driver documentation in docs/migraphx-driver.rst, docs/driver/compile.rst, and docs/driver/read.rst was missing several command-line options and contained inconsistent descriptions compared to the source implementation.

Technical Details

Commands Added

  • time - Compiles and runs input graph and reports total time

Options Added

  • --trim-size | -s - Number of instructions in trim model
  • --dim-param - Symbolic parameter dimension configuration
  • --output-names - Node output name specification
  • --mlir - MLIR offload control
  • --apply-pass | -p - Model pass application
  • --python | --py - Python program output (added --python alias)
  • --int4-weights - INT4 weight quantization
  • --bisect | -b - Bisection verification
  • --compiled-model | -c - Compiled model usage

Consistency Fixes

  • Standardized --exhaustive-tune description: "Exhaustively search for best tuning parameters for kernels"
  • Standardized --fp8 description: "Quantize for FP8"
  • Unified acronym capitalization (MLIR, FP16, BF16, INT8, FP8, INT4) to match CPU/GPU convention
  • Aligned all descriptions with source code in src/driver/main.cpp

Files Modified

  • docs/migraphx-driver.rst - Main driver reference (added time command to commands table)
  • docs/driver/read.rst - Read command options
  • docs/driver/compile.rst - Compile command options
  • docs/reference/driver-options.rst - Options reference (added time command section)

Changelog Category

  • Added: New functionality.
  • Changed: Changes to existing functionality.
  • Removed: Functionality or support that has been removed. (Compared to a previous release)
  • Optimized: Component performance that has been optimized or improved.
  • Resolved Issues: Known issues from a previous version that have been resolved.
  • Not Applicable: This PR is not to be included in the changelog.
Original prompt

Update @docs/migraphx-driver.rst, @docs/driver/compile.rst, and @docs/driver/read.rst with missing options and look for inconsistencies


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI changed the title [WIP] Update documentation for migraphx driver options Update driver documentation with missing options and fix inconsistencies Nov 26, 2025
Copilot AI requested a review from CharlieL7 November 26, 2025 15:05
Copilot finished work on behalf of CharlieL7 November 26, 2025 15:05
@CharlieL7
Copy link
Collaborator

@copilot Add documentation about driver time

Copy link
Contributor Author

Copilot AI commented Nov 26, 2025

@copilot Add documentation about driver time

Added documentation for driver time in commit d1cfbcb. The time command has been added to the commands table in migraphx-driver.rst and a full section with its options has been added to driver-options.rst.

Copilot finished work on behalf of CharlieL7 November 26, 2025 20:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants