-
Notifications
You must be signed in to change notification settings - Fork 310
Update README #1890
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 README #1890
Conversation
README.md
Outdated
| [keras.io/keras_nlp](https://keras.io/keras_nlp/). | ||
|
|
||
| ## Installation | ||
| KerasHub that is currently available on PiPy is a pre release version. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Newline after markdown heading. Don't recommend pinning the version. Also I would do a little more than this probably?
- Very briefly explain what the pre-release means, e.g. new api might change a lot before release.
- Recommend
pip install keras-nlpfor a stable experience. - Don't show
pip install keras-hubat all now. Recommendpip install keras-hub-nightlyfor people that want to try the pre-release of keras-hub. - Update the quickstart to show
import keras_nlpandkeras_nlpusages. - Finally make a new PR with the release day updates you want and leave it staged (but not merged). We land it at the same time we land keras.io updates. This readme is docs, like keras.io.
| ) | ||
|
|
||
| # Load a BERT model. | ||
| classifier = keras_hub.models.Classifier.from_preset( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did we mean to change this back to keras_nlp?
Looks like yes, but wanted to confirm.
No description provided.