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

change directml to dml in README code example for execution provider #435

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

BobJr23
Copy link

@BobJr23 BobJr23 commented Aug 22, 2024

Update README to use correct DirectML execution provider argument (dml)

Summary by Sourcery

Correct the execution provider name in the README.md usage instructions from 'directml' to 'dml'.

Documentation:

  • Update the README.md to correct the execution provider name from 'directml' to 'dml' in the usage instructions.

changed directml to dml (directml doesn't work)
Copy link
Contributor

sourcery-ai bot commented Aug 22, 2024

Reviewer's Guide by Sourcery

This pull request updates the README.md file to correct the execution provider argument for DirectML. The change replaces 'directml' with 'dml' in the command-line example, as 'directml' doesn't work.

File-Level Changes

Files Changes
README.md Updated the command-line argument for the DirectML execution provider from 'directml' to 'dml'

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

@BobJr23 BobJr23 changed the title Update README.md change directml to dml in README code example for execution provider Aug 22, 2024
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @BobJr23 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The change looks good, but consider improving the commit message to be more specific. Instead of 'directml doesn't work', it would be clearer to say something like 'Update README to use correct DirectML execution provider argument (dml)'.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

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.

1 participant