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

fix readme code sanity check #246

Merged
merged 1 commit into from
Aug 29, 2024
Merged

fix readme code sanity check #246

merged 1 commit into from
Aug 29, 2024

Conversation

aniketmaurya
Copy link
Collaborator

@aniketmaurya aniketmaurya commented Aug 29, 2024

Before submitting
  • Was this discussed/agreed via a Github issue? (no need for typos and docs improvements)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure to update the docs?
  • Did you write any new necessary tests?

⚠️ How does this PR impact the user? ⚠️

Describe (in plain English, not technical Jargon) how this improves the user experience. If you can't tie it back to a real tangible, user goal or describe it in plain english, it's a hint that this is likely not needed and is probably an "engineering nit".

GOOD:

"As a user, I need to serve models faster. This PR focuses on enabling speed gains by using GPUs"

BAD:

"This PR enables GPUs".
This is bad because the user problem is not clear... instead it just jumps to the solution without any context.

PRs without this will not be merged.


What does this PR do?

The README's sanity check fails due to the litgpt serve code being added as a Python snippet. This PR provides a fix for that issue.

Before

image

After

image

PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in GitHub issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃

Copy link

codecov bot commented Aug 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84%. Comparing base (9376264) to head (49cdb42).
Report is 1 commits behind head on main.

Additional details and impacted files
@@         Coverage Diff         @@
##           main   #246   +/-   ##
===================================
+ Coverage    83%    84%   +1%     
===================================
  Files        13     13           
  Lines      1048   1056    +8     
===================================
+ Hits        875    890   +15     
+ Misses      173    166    -7     

@aniketmaurya aniketmaurya added bug Something isn't working ci / tests labels Aug 29, 2024
@aniketmaurya aniketmaurya self-assigned this Aug 29, 2024
@williamFalcon williamFalcon merged commit bb60919 into main Aug 29, 2024
20 checks passed
@williamFalcon williamFalcon deleted the aniketmaurya-patch-1 branch August 29, 2024 17:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working ci / tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants