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 BERT on IMDb movie reviews:

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

import keras_hub
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_hub.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

To install the latest KerasHub release with Keras 3, simply run:

pip install --upgrade keras-hub

To install the latest nightly changes for both KerasHub and Keras, you can use our nightly package.

pip install --upgrade keras-hub-nightly

Note that currently, installing KerasHub will always pull in TensorFlow 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 import 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 consider 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.dev202409290341.tar.gz (423.7 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for keras_hub_nightly-0.16.1.dev202409290341.tar.gz
Algorithm Hash digest
SHA256 da271eb471f2bcb759802d584f37569b0e09357501ba2f76b9e4b1b993e11737
MD5 ec21fe162f35c47d59508573e6c947ea
BLAKE2b-256 2e8a473a26160be589a4ec5d203290e2a04674d2429b1c886d1bc442cc57e2b4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for keras_hub_nightly-0.16.1.dev202409290341-py3-none-any.whl
Algorithm Hash digest
SHA256 ff892d6cca86766c66c9a7dfc63bcab161aebf6e25d2b855637da236fd2f09ae
MD5 478233d73873828c6c06c4a2e06688d6
BLAKE2b-256 113bc675c006ac524d41f2a2e82fda3f9331ce59aa18b9f14f9a03b6926bcf79

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