[](https://github.com/keras-team/keras-core/actions?query=workflow%3ATests+branch%3Amain)
[](https://badge.fury.io/py/keras-core)
# 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.
**WARNING:** At this time, this package is experimental.
It has rough edges and not everything might work as expected.
We are currently hard at work improving it.
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 a local development version:
1. Install dependencies:
```
pip install -r requirements.txt
```
2. Run installation command from the root directory.
```
python pip_build.py --install
```
You should also install your backend of choice: `tensorflow`, `jax`, or `torch`.
Note that `tensorflow` is required for using certain Keras Core features: certain preprocessing layers as
well as `tf.data` pipelines.
## Configuring your backend
You can export the environment variable `KERAS_BACKEND` or you can edit your local config file at `~/.keras/keras.json`
to configure your backend. Available backend options are: `"tensorflow"`, `"jax"`, `"torch"`. Example:
```
export KERAS_BACKEND="jax"
```
In Colab, you can do:
```python
import os
os.environ["KERAS_BACKEND"] = "jax"
import keras_core as keras
```
**Note:** The backend must be configured before importing `keras_core`, and the backend cannot be changed after
the package has been imported.
## Backwards compatibility
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 components, 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 PyTorch `DataLoaders`.
## Why use Keras Core?
- Run your high-level Keras workflows on top of any framework -- benefiting at will from the advantages of each framework,
e.g. the scalability and performance of JAX or the production ecosystem options of TensorFlow.
- Write custom components (e.g. layers, models, metrics) that you can use in low-level workflows in any framework.
- You can take a Keras model and train it in a training loop written from scratch in native TF, JAX, or PyTorch.
- You can take a Keras model and use it as part of a PyTorch-native `Module` or as part of a JAX-native model function.
- 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/keras-team/keras-core",
"name": "keras-core",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "",
"author": "Keras team",
"author_email": "keras-users@googlegroups.com",
"download_url": "https://files.pythonhosted.org/packages/99/c5/8ad2a43f3ba78a1305bbf84a38fd0092207fd4abb69c37b7c88898cdb991/keras-core-0.1.7.tar.gz",
"platform": null,
"description": "[](https://github.com/keras-team/keras-core/actions?query=workflow%3ATests+branch%3Amain)\n[](https://badge.fury.io/py/keras-core)\n\n# Keras Core: A new multi-backend Keras\n\nKeras Core is a new multi-backend implementation of the Keras API, with support for TensorFlow, JAX, and PyTorch.\n\n**WARNING:** At this time, this package is experimental.\nIt has rough edges and not everything might work as expected.\nWe are currently hard at work improving it.\n\nOnce ready, this package will become Keras 3.0 and subsume `tf.keras`.\n\n## Local installation\n\nKeras Core is compatible with Linux and MacOS systems. To install a local development version:\n\n1. Install dependencies:\n\n```\npip install -r requirements.txt\n```\n\n2. Run installation command from the root directory.\n\n```\npython pip_build.py --install\n```\n\nYou should also install your backend of choice: `tensorflow`, `jax`, or `torch`.\nNote that `tensorflow` is required for using certain Keras Core features: certain preprocessing layers as\nwell as `tf.data` pipelines.\n\n## Configuring your backend\n\nYou can export the environment variable `KERAS_BACKEND` or you can edit your local config file at `~/.keras/keras.json`\nto configure your backend. Available backend options are: `\"tensorflow\"`, `\"jax\"`, `\"torch\"`. Example:\n\n```\nexport KERAS_BACKEND=\"jax\"\n```\n\nIn Colab, you can do:\n\n```python\nimport os\nos.environ[\"KERAS_BACKEND\"] = \"jax\"\n\nimport keras_core as keras\n```\n\n**Note:** The backend must be configured before importing `keras_core`, and the backend cannot be changed after \nthe package has been imported.\n\n## Backwards compatibility\n\nKeras Core is intended to work as a drop-in replacement for `tf.keras` (when using the TensorFlow backend). Just take your\nexisting `tf.keras` code, change the `keras` imports to `keras_core`, make sure that your calls to `model.save()` are using\nthe up-to-date `.keras` format, and you're done.\n\nIf your `tf.keras` model does not include custom components, you can start running it on top of JAX or PyTorch immediately.\n\nIf it does include custom components (e.g. custom layers or a custom `train_step()`), it is usually possible to convert it\nto a backend-agnostic implementation in just a few minutes.\n\nIn addition, Keras models can consume datasets in any format, regardless of the backend you're using:\nyou can train your models with your existing `tf.data.Dataset` pipelines or PyTorch `DataLoaders`.\n\n## Why use Keras Core?\n\n- Run your high-level Keras workflows on top of any framework -- benefiting at will from the advantages of each framework,\ne.g. the scalability and performance of JAX or the production ecosystem options of TensorFlow.\n- Write custom components (e.g. layers, models, metrics) that you can use in low-level workflows in any framework.\n - You can take a Keras model and train it in a training loop written from scratch in native TF, JAX, or PyTorch.\n - You can take a Keras model and use it as part of a PyTorch-native `Module` or as part of a JAX-native model function.\n- Make your ML code future-proof by avoiding framework lock-in.\n- As a PyTorch user: get access to power and usability of Keras, at last!\n- As a JAX user: get access to a fully-featured, battle-tested, well-documented modeling and training library.\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Multi-backend Keras.",
"version": "0.1.7",
"project_urls": {
"Homepage": "https://github.com/keras-team/keras-core"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "95f7b8dcff937ea64f822f0d3fe8c6010793406b82d14467cd0e9eecea458a40",
"md5": "937f874183fe252bbc19f4145dff2963",
"sha256": "01f9f322d4b7e6e0a64d9cc3de022144ddf82ff88a0ac2b68e49f1a67d4a7ff0"
},
"downloads": -1,
"filename": "keras_core-0.1.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "937f874183fe252bbc19f4145dff2963",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 950844,
"upload_time": "2023-09-20T23:09:21",
"upload_time_iso_8601": "2023-09-20T23:09:21.745084Z",
"url": "https://files.pythonhosted.org/packages/95/f7/b8dcff937ea64f822f0d3fe8c6010793406b82d14467cd0e9eecea458a40/keras_core-0.1.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "99c58ad2a43f3ba78a1305bbf84a38fd0092207fd4abb69c37b7c88898cdb991",
"md5": "f45ce3d520d357d73254b8aa402364da",
"sha256": "a68580dc6910662026afdb5cda21e157f5163c6a77e86beae0e8d1de40234c07"
},
"downloads": -1,
"filename": "keras-core-0.1.7.tar.gz",
"has_sig": false,
"md5_digest": "f45ce3d520d357d73254b8aa402364da",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 681372,
"upload_time": "2023-09-20T23:09:23",
"upload_time_iso_8601": "2023-09-20T23:09:23.989481Z",
"url": "https://files.pythonhosted.org/packages/99/c5/8ad2a43f3ba78a1305bbf84a38fd0092207fd4abb69c37b7c88898cdb991/keras-core-0.1.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-20 23:09:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "keras-team",
"github_project": "keras-core",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "keras-core"
}
JSON
