Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
fchollet committed Jul 7, 2023
1 parent eb1bb72 commit 63436e8
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Keras Core: a new multi-backend Keras
# Keras Core: A new multi-backend Keras

Keras Core is a new multi-backend implementation of the Keras API, with support for TensorFlow, JAX, and PyTorch.

Expand All @@ -10,7 +10,7 @@ Once ready, this package will become Keras 3.0 and subsume `tf.keras`.

## Local installation

Keras Core is compatible with Linux and MacOS systems. To install it locally:
Keras Core is compatible with Linux and MacOS systems. To install a local development version:

1. Install dependencies:

Expand All @@ -37,17 +37,28 @@ to configure your backend. Available backend options are: `"tensorflow"`, `"jax"
export KERAS_BACKEND="jax"
```

In Colab, you can do:

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

import keras_core as keras
```

## Backwards compatibility

Keras Core is intend to work as a drop-in replacement for `tf.keras` (when using the TensorFlow backend).
Keras Core is intended to work as a drop-in replacement for `tf.keras` (when using the TensorFlow backend). Just take your
existing `tf.keras` code, change the `keras` imports to `keras_core`, make sure that your calls to `model.save()` are using
the up-to-date `.keras` format, and you're done.

If your `tf.keras` model does not include custom compoments, you can start running it on top of JAX or PyTorch immediately.

If it does include custom components (e.g. custom layers or a custom `train_step()`), it is usually possible to convert it
to a backend-agnostic implementation in just a few minutes.

In addition, Keras models can consume datasets in any format, regardless of the backend you're using:
you can train your models with your existing tf.data.Dataset pipelines or Torch DataLoaders.
you can train your models with your existing `tf.data.Dataset` pipelines or PyTorch `DataLoaders`.

## Why use Keras Core?

Expand All @@ -59,7 +70,3 @@ e.g. the scalability and performance of JAX or the production ecosystem options
- Make your ML code future-proof by avoiding framework lock-in.
- As a PyTorch user: get access to power and usability of Keras, at last!
- As a JAX user: get access to a fully-featured, battle-tested, well-documented modeling and training library.

## Credits

TODO

0 comments on commit 63436e8

Please sign in to comment.