Skip to main content

Industry-strength Natural Language Processing extensions for Keras.

Project description

KerasHub: Multi-framework Models

Python contributions welcome

[!IMPORTANT] 📢 KerasNLP is becoming KerasHub! 📢 Read the announcement.

We have renamed the repo to KerasHub in preparation for the release, but have not yet released the new package. Follow the announcement for news.

KerasHub is a library that supports natural language processing, computer vision, audio, and multimodal backbones and task models, working natively with TensorFlow, JAX, or PyTorch. KerasHub provides a repository of pre-trained models and a collection of lower-level building blocks for these tasks. Built on Keras 3, models can be trained and serialized in any framework and re-used in another without costly migrations.

This library is an extension of the core Keras API; all high-level modules are Layers and Models that receive that same level of polish as core Keras. If you are familiar with Keras, congratulations! You already understand most of KerasHub.

All models support JAX, TensorFlow, and PyTorch from a single model definition and can be fine-tuned on GPUs and TPUs out of the box. Models can be trained on individual accelerators with built-in PEFT techniques, or fine-tuned at scale with model and data parallel training. See our Getting Started guide to start learning our API. Browse our models on Kaggle. We welcome contributions.

Quick Links

For everyone

For contributors

Quickstart

Fine-tune a BERT classifier on IMDb movie reviews:

import os
os.environ["KERAS_BACKEND"] = "jax"  # Or "tensorflow" or "torch"!

import keras_nlp
import tensorflow_datasets as tfds

imdb_train, imdb_test = tfds.load(
    "imdb_reviews",
    split=["train", "test"],
    as_supervised=True,
    batch_size=16,
)

# Load a BERT model.
classifier = keras_nlp.models.Classifier.from_preset(
    "bert_base_en",
    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."])

Try it out in a colab. For more in depth guides and examples, visit keras.io/keras_nlp.

Installation

KerasHub is currently in pre-release. Note that pre-release versions may introduce breaking changes to the API in future versions. For a stable and supported experience, we recommend installing keras-nlp version 0.15.1:

pip install keras-nlp==0.15.1

To try out the latest pre-release version of KerasHub, you can use our nightly package:

pip install keras-hub-nightly

KerasHub currently requires TensorFlow to be installed for use of the tf.data API for preprocessing. Even when pre-processing with tf.data, training can still happen on any backend.

Read Getting started with Keras for more information on installing Keras 3 and compatibility with different frameworks.

[!IMPORTANT] We recommend using KerasHub with TensorFlow 2.16 or later, as TF 2.16 packages Keras 3 by default.

Configuring your backend

If you have Keras 3 installed in your environment (see installation above), you can use KerasHub with any of JAX, TensorFlow and PyTorch. To do so, set the KERAS_BACKEND environment variable. For example:

export KERAS_BACKEND=jax

Or in Colab, with:

import os
os.environ["KERAS_BACKEND"] = "jax"

import keras_hub

[!IMPORTANT] Make sure to set the KERAS_BACKEND before importing any Keras libraries; it will be used to set up Keras when it is first imported.

Compatibility

We follow Semantic Versioning, and plan to provide backwards compatibility guarantees both for code and saved models built with our components. While we continue with pre-release 0.y.z development, we may break compatibility at any time and APIs should not be considered stable.

Disclaimer

KerasHub provides access to pre-trained models via the keras_hub.models API. 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, BLOOM, DeBERTa, DistilBERT, GPT-2, Llama, Mistral, OPT, RoBERTa, Whisper, and XLM-RoBERTa.

Citing KerasHub

If KerasHub helps your research, we appreciate your citations. Here is the BibTeX entry:

@misc{kerashub2024,
  title={KerasHub},
  author={Watson, Matthew, and  Chollet, Fran\c{c}ois and Sreepathihalli,
  Divyashree, and Saadat, Samaneh and Sampath, Ramesh, and Rasskin, Gabriel and
  and Zhu, Scott and Singh, Varun and Wood, Luke and Tan, Zhenyu and Stenbit,
  Ian and Qian, Chen, and Bischof, Jonathan and others},
  year={2024},
  howpublished={\url{https://github.com/keras-team/keras-hub}},
}

Acknowledgements

Thank you to all of our wonderful contributors!

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

keras_hub_nightly-0.16.1.dev202410100339.tar.gz (439.3 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file keras_hub_nightly-0.16.1.dev202410100339.tar.gz.

File metadata

File hashes

Hashes for keras_hub_nightly-0.16.1.dev202410100339.tar.gz
Algorithm Hash digest
SHA256 f0ca26668b1bf6edec13becd92b5e9659abcc2b818966afc7a12a0a0821cb69d
MD5 3c41036cc2a7744691b34404e4b1524e
BLAKE2b-256 46efe1f076e22e480d0c10a87388cd413a8e4abac8682ecf09d68e57f31ad311

See more details on using hashes here.

File details

Details for the file keras_hub_nightly-0.16.1.dev202410100339-py3-none-any.whl.

File metadata

File hashes

Hashes for keras_hub_nightly-0.16.1.dev202410100339-py3-none-any.whl
Algorithm Hash digest
SHA256 be8f454f55e63b82501f0fbb07368bf913f99c0528380375af06671c7e15045d
MD5 d07ae0686e451c28b92e120e0f78cc8c
BLAKE2b-256 a7dbdee82e9c6ea6cb899427e3ce64b8f7c7f4343f0e13ae66d362381dfaf7a1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page