Package: keras-nlp
KerasNLP: Modular NLP Workflows for KerasKerasNLP is a natural language processing library that works natively
with TensorFlow, JAX, or PyTorch. Built on Keras 3, these models, layers,
metrics, and tokenizers can be trained and serialized in any framework and
re-used in another without costly migrations.KerasNLP supports users through their entire development cycle. Our workflows
are built from modular components that have state-of-the-art preset weights when
used out-of-the-box and are easily customizable when more control is needed.This library is an extension of the core Keras API; all high-level modules areLayersorModelsthat receive that same level of polish
as core Keras. If you are familiar with Keras, congratulations! You already
understand most of KerasNLP.See ourGetting Started guideto start learning our API. We welcomecontributions.Quick LinksFor everyoneHome PageDeveloper GuidesAPI ReferenceGetting Started guideFor contributorsContributing GuideRoadmapStyle GuideAPI Design GuideCall for ContributionsInstallationKerasNLP supports both Keras 2 and Keras 3. We recommend Keras 3 for all new
users, as it enables using KerasNLP models and layers with JAX, TensorFlow and
PyTorch.Keras 2 InstallationTo install the latest KerasNLP release with Keras 2, simply run:pip install --upgrade keras-nlpKeras 3 InstallationThere are currently two ways to install Keras 3 with KerasNLP. To install the
stable versions of KerasNLP and Keras 3, you should install Keras 3afterinstalling KerasNLP. This is a temporary step while TensorFlow is pinned to
Keras 2, and will no longer be necessary after TensorFlow 2.16.pip install --upgrade keras-nlp
pip install --upgrade keras>=3To install the latest nightly changes for both KerasNLP and Keras, you can use
our nightly package.pip install --upgrade keras-nlp-nightly[!IMPORTANT]
Keras 3 will not function with TensorFlow 2.14 or earlier.ReadGetting started with Kerasfor more information
on installing Keras 3 and compatibility with different frameworks.QuickstartFine-tune BERT on a small sentiment analysis task using thekeras_nlp.modelsAPI:importosos.environ["KERAS_BACKEND"]="tensorflow"# Or "jax" or "torch"!importkeras_nlpimporttensorflow_datasetsastfdsimdb_train,imdb_test=tfds.load("imdb_reviews",split=["train","test"],as_supervised=True,batch_size=16,)# Load a BERT model.classifier=keras_nlp.models.BertClassifier.from_preset("bert_base_en_uncased",num_classes=2,activation="softmax",)# Fine-tune on IMDb movie reviews.classifier.fit(imdb_train,validation_data=imdb_test)# Predict two new examples.classifier.predict(["What an amazing movie!","A total waste of my time."])For more in depth guides and examples, visithttps://keras.io/keras_nlp/.Configuring your backendIf you have Keras 3 installed in your environment (see installation above),
you can use KerasNLP with any of JAX, TensorFlow and PyTorch. To do so, set theKERAS_BACKENDenvironment variable. For example:exportKERAS_BACKEND=jaxOr in Colab, with:importosos.environ["KERAS_BACKEND"]="jax"importkeras_nlp[!IMPORTANT]
Make sure to set theKERAS_BACKENDbefore import any Keras libraries, it
will be used to set up Keras when it is first imported.CompatibilityWe followSemantic Versioning, and plan to
provide backwards compatibility guarantees both for code and saved models built
with our components. While we continue with pre-release0.y.zdevelopment, we
may break compatibility at any time and APIs should not be consider stable.DisclaimerKerasNLP provides access to pre-trained models via thekeras_nlp.modelsAPI.
These pre-trained models are provided on an "as is" basis, without warranties
or conditions of any kind. The following underlying models are provided by third
parties, and subject to separate licenses:
BART, DeBERTa, DistilBERT, GPT-2, OPT, RoBERTa, Whisper, and XLM-RoBERTa.Citing KerasNLPIf KerasNLP helps your research, we appreciate your citations.
Here is the BibTeX entry:@misc{kerasnlp2022,title={KerasNLP},author={Watson, Matthew, and Qian, Chen, and Bischof, Jonathan and Chollet,Fran\c{c}ois and others},year={2022},howpublished={\url{https://github.com/keras-team/keras-nlp}},}AcknowledgementsThank you to all of our wonderful contributors!