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

Add imports to code example in the README #188

Merged
merged 2 commits into from
Jun 19, 2024

Conversation

jank324
Copy link
Member

@jank324 jank324 commented Jun 19, 2024

Description

Add imports to the code examples in the README.

Motivation and Context

Makes sure the code example is complete and runs as it is.

  • I have raised an issue to propose this change (required for new features and bug fixes)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)

Checklist

  • I have updated the changelog accordingly (required).
  • My change requires a change to the documentation.
  • I have updated the tests accordingly (required for a bug fix or a new feature).
  • I have updated the documentation accordingly.
  • I have reformatted the code and checked that formatting passes (required).
  • I have have fixed all issues found by flake8 (required).
  • I have ensured that all pytest tests pass (required).
  • I have run pytest on a machine with a CUDA GPU and made sure all tests pass (required).
  • I have checked that the documentation builds (required).

Note: We are using a maximum length of 88 characters per line

@jank324 jank324 self-assigned this Jun 19, 2024
@jank324 jank324 added the enhancement New feature or request label Jun 19, 2024
@jank324 jank324 merged commit e2d0a7d into master Jun 19, 2024
10 of 11 checks passed
@jank324 jank324 deleted the code-example-readme-imports branch June 19, 2024 08:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant