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

Update code examples in readme #494

Merged
merged 2 commits into from
Jan 2, 2023
Merged

Update code examples in readme #494

merged 2 commits into from
Jan 2, 2023

Conversation

eungbean
Copy link
Contributor

@eungbean eungbean commented Jan 2, 2023

minor update on examples based on the current version of train.py.

  • fix config to cfg
  • [L870] add missing cfg

## What does this PR do?

<!--
Please include a summary of the change and which issue is fixed.
Please also include relevant motivation and context.
List any dependencies that are required for this change.
List all the breaking changes introduced by this pull request.
-->

Fixes #\<issue_number>

## Before submitting

- [ * ] Did you make sure **title is self-explanatory** and **the description concisely explains the PR**?
- [ * ] Did you make sure your **PR does only one thing**, instead of bundling different changes together?
- [ * ] Did you list all the **breaking changes** introduced by this pull request?
- [ * ] Did you **test your PR locally** with `pytest` command?
- [ * ] Did you **run pre-commit hooks** with `pre-commit run -a` command?

## Did you have fun?

Make sure you had fun coding 🙃

@codecov-commenter
Copy link

Codecov Report

Base: 83.71% // Head: 83.71% // No change to project coverage 👍

Coverage data is based on head (627fe82) compared to base (37b57ce).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #494   +/-   ##
=======================================
  Coverage   83.71%   83.71%           
=======================================
  Files           9        9           
  Lines         350      350           
=======================================
  Hits          293      293           
  Misses         57       57           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@ashleve ashleve changed the base branch from main to dev January 2, 2023 22:35
@ashleve ashleve added the documentation Improvements or additions to documentation label Jan 2, 2023
@ashleve ashleve changed the title update minor code example based on current version Update code examples in readme Jan 2, 2023
README.md Outdated Show resolved Hide resolved
Copy link
Owner

@ashleve ashleve left a comment

Choose a reason for hiding this comment

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

Thank you for the update!

@ashleve ashleve merged commit 2d44703 into ashleve:dev Jan 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants