ViCCo-Group / thingsvision

Python package for extracting representations from state-of-the-art computer vision models
https://vicco-group.github.io/thingsvision/
MIT License
157 stars 21 forks source link

Major readme overhaul, closes #66 #102

Closed PhilippKaniuth closed 2 years ago

PhilippKaniuth commented 2 years ago

This PR presents a major overhaul of the README.md. I tried to create an initial, not-too-comprehensive, visually pleasing overview that will serve as an entry point to this package also for users not too familiar with DNNs.

There are some changes I will make to the docs that will be based on this readme change. I will await the review of this PR before submitting the PR re the docs.

@LukasMut I included an "Acknowledgements" section which is currently empty. You'll have to decide whether and if how you want to populate or get rid of it :)

codecov-commenter commented 2 years ago

Codecov Report

Base: 79.65% // Head: 79.67% // Increases project coverage by +0.01% :tada:

Coverage data is based on head (f66b4cf) compared to base (399a15c). Patch has no changes to coverable lines.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #102 +/- ## ========================================== + Coverage 79.65% 79.67% +0.01% ========================================== Files 23 24 +1 Lines 1047 1048 +1 Branches 151 151 ========================================== + Hits 834 835 +1 Misses 176 176 Partials 37 37 ``` | Flag | Coverage Δ | | |---|---|---| | unittests | `79.67% <ø> (+0.01%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ViCCo-Group#carryforward-flags-in-the-pull-request-comment) to find out more. | [Impacted Files](https://codecov.io/gh/ViCCo-Group/THINGSvision/pull/102?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ViCCo-Group) | Coverage Δ | | |---|---|---| | [thingsvision/\_version.py](https://codecov.io/gh/ViCCo-Group/THINGSvision/pull/102/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ViCCo-Group#diff-dGhpbmdzdmlzaW9uL192ZXJzaW9uLnB5) | `100.00% <0.00%> (ø)` | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ViCCo-Group). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ViCCo-Group)

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