Refine readme.md #1292
Refine readme.md #1292
Conversation
LukeWood
force-pushed
the
LukeWood-patch-1
branch
from
b39d76e
to
15a4578
Compare
|
@fchollet @jbischof @ianstenbit I updated the README a bit to try to be a bit more "community" oriented - please let me know what you think! Some copyedits too. I consider our README to be one of the most important files in the repo - so please feel free to nitpick! |
LukeWood
requested review from
bhack,
chenmoneygithub,
mattdangerw and
qlzh727
and removed request for
bhack
|
(added a few others as README is pretty important) |
README.md
Outdated
|
|
||
| # Mission | ||
|
|
||
| KerasCV is a layered repository consisting of core components and modeling components. | ||
| KerasCV is a computer vision library of modular computer vision oriented Keras components. |
There was a problem hiding this comment.
It might be cool if we could align the first sentences of KerasCV's and KerasNLP's mission. For KerasNLP we have -> "KerasNLP is a natural language processing library that supports users through their entire development cycle." Def open to changing that if we find some language we think will be exciting for readers and applicable for both projects.
cc @jbischof
There was a problem hiding this comment.
Open to feedback. I think the CV selling point is a bit different in that its based on modularity - but open to feedback.
There was a problem hiding this comment.
Modular only makes our second sentence currently :P, but I would be totally down to bump it up. Totally fine to leave both as is if this is feeling too tricky, was just thinking it might be a good way to show some alignment between the packages.
|
/gcbrun |
|
@jbischof If you are interested, some time ago, I've tried to propose some template sections to lower the cognitive overhead when navigating across ecosystem repos Readme files: We have also the contributing markdown but almost without review: |
Thanks @bhack for this and your many other contributions! I don't want to force a big rewrite on @LukeWood at this time but would be happy if he wanted to follow the templates as well |
You are right but the full story begin one year ago. 😉 |
Great idea - I even have one written: https://raw.githubusercontent.com/keras-team/keras-io/master/templates/keras_cv/index.md added |
|
/gcbrun |
|
Thank you everyone for your reviews and comments! |
* Fix inference for jittered resize * Fix jittered resize * Inference test * Inference test * README update * README update * README update * Ian comments * Matt comment * Matt comment * Fix haifeng comment * Fix Jonathan comment
Currently we're really highlighting a few use cases in the 3P entrypoint. Our APIs are in no way restricted to these use cases (even if they are internally) and we should communicate that to 3p users.
The goal of the package is to solve all OD, Segmentation, and classification tasks; so lets make sure we communicate that clearly to users.
Note: leaving this PR open to discuss