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.

Sign up for GitHub

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

Jump to bottom

Refactor: Improve Readme #188

Merged
merged 2 commits into from
Jul 16, 2024
Merged

Refactor: Improve Readme #188

merged 2 commits into from
Jul 16, 2024

Conversation

mali-git
Copy link
Member

@mali-git mali-git commented Jul 15, 2024 •
edited

What does this PR do?

This PR introduces minor stylistic improvements to the README and adds additional badges to enhance the visual appearance and provide more information at a glance.

General Changes

  • Centered the title and badges for a more visually appealing layout.
  • Added Python and PyTorch badges to showcase the technologies used.

Breaking Changes

  • None

Checklist before submitting final PR

  • My PR is minimal and addresses one issue in isolation
  • I have merged the latest version of the target branch into this feature branch
  • I have reviewed my own code w.r.t. correct implementation, missing type hints, proper documentation, etc.
  • I have run a sample config for model training
  • I have checked that all tests run through (python tests/tests.py)

@mali-git mali-git requested a review from le1nux July 16, 2024 08:01
le1nux
le1nux approved these changes Jul 16, 2024
View reviewed changes
Copy link
Member

@le1nux le1nux left a comment

Choose a reason for hiding this comment

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

Great additions! Looks way more appealing now. I'll merge this :-)

@le1nux le1nux merged commit 26366c8 into main Jul 16, 2024
3 of 4 checks passed
@le1nux le1nux deleted the improve_readme branch July 16, 2024 09:00
@le1nux le1nux added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@le1nux le1nux le1nux approved these changes

Assignees

@mali-git mali-git

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@mali-git @le1nux