# Keras Recommenders
Keras Recommenders is a library for building recommender systems on top of
Keras 3. Keras Recommenders works natively with TensorFlow, JAX, or PyTorch. It
provides a collection of building blocks which help with the full workflow of
creating a recommender system. As it's 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
receive that same level of polish as core Keras. If you are familiar with Keras,
congratulations! You already understand most of Keras Recommenders.
## Installation
Keras Recommenders is available on PyPI as `keras-rs`:
```bash
pip install keras-rs
```
To try out the latest version of Keras Recommenders, you can use our nightly
package:
```bash
pip install keras-rs-nightly
```
Read [Getting started with Keras](https://keras.io/getting_started/) for more
information on installing Keras 3 and compatibility with different frameworks.
> [!IMPORTANT]
> We recommend using Keras Recommenders 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 Keras Recommenders with any of JAX, TensorFlow and PyTorch. To do so,
set the `KERAS_BACKEND` environment variable. For example:
```shell
export KERAS_BACKEND=jax
```
Or in Colab, with:
```python
import os
os.environ["KERAS_BACKEND"] = "jax"
import keras_rs
```
> [!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](https://semver.org/), 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.
## Citing Keras Recommenders
If Keras Recommenders helps your research, we appreciate your citations.
Here is the BibTeX entry:
```bibtex
@misc{kerasrecommenders2024,
title={KerasRecommenders},
author={Hertschuh, Fabien and Chollet, Fran\c{c}ois and Sharma, Abheesht and others},
year={2024},
howpublished={\url{https://github.com/keras-team/keras-rs}},
}
```
## Acknowledgements
Thank you to all of our wonderful contributors!
<a href="https://github.com/keras-team/keras-rs/graphs/contributors">
<img src="https://contrib.rocks/image?repo=keras-team/keras-rs" />
</a>
Raw data
{
"_id": null,
"home_page": null,
"name": "keras-rs-nightly",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Keras RS team <keras-rs@google.com>",
"download_url": "https://files.pythonhosted.org/packages/5f/ab/3abbadc975e2a37ba4e423357243f880b60a2440675cc049f79ad49a1ec1/keras_rs_nightly-0.0.1.dev2025022503.tar.gz",
"platform": null,
"description": "# Keras Recommenders\n\nKeras Recommenders is a library for building recommender systems on top of\nKeras 3. Keras Recommenders works natively with TensorFlow, JAX, or PyTorch. It\nprovides a collection of building blocks which help with the full workflow of\ncreating a recommender system. As it's built on Keras 3, models can be trained\nand serialized in any framework and re-used in another without costly\nmigrations.\n\nThis library is an extension of the core Keras API; all high-level modules\nreceive that same level of polish as core Keras. If you are familiar with Keras,\ncongratulations! You already understand most of Keras Recommenders.\n\n## Installation\n\nKeras Recommenders is available on PyPI as `keras-rs`:\n\n```bash\npip install keras-rs\n```\n\nTo try out the latest version of Keras Recommenders, you can use our nightly\npackage:\n\n```bash\npip install keras-rs-nightly\n```\n\nRead [Getting started with Keras](https://keras.io/getting_started/) for more\ninformation on installing Keras 3 and compatibility with different frameworks.\n\n> [!IMPORTANT]\n> We recommend using Keras Recommenders with TensorFlow 2.16 or later, as\n> TF 2.16 packages Keras 3 by default.\n\n## Configuring your backend\n\nIf you have Keras 3 installed in your environment (see installation above), you\ncan use Keras Recommenders with any of JAX, TensorFlow and PyTorch. To do so,\nset the `KERAS_BACKEND` environment variable. For example:\n\n```shell\nexport KERAS_BACKEND=jax\n```\n\nOr in Colab, with:\n\n```python\nimport os\nos.environ[\"KERAS_BACKEND\"] = \"jax\"\n\nimport keras_rs\n```\n\n> [!IMPORTANT]\n> Make sure to set the `KERAS_BACKEND` **before** importing any Keras libraries;\n> it will be used to set up Keras when it is first imported.\n\n## Compatibility\n\nWe follow [Semantic Versioning](https://semver.org/), and plan to provide\nbackwards compatibility guarantees both for code and saved models built with our\ncomponents. While we continue with pre-release `0.y.z` development, we may break\ncompatibility at any time and APIs should not be considered stable.\n\n## Citing Keras Recommenders\n\nIf Keras Recommenders helps your research, we appreciate your citations.\nHere is the BibTeX entry:\n\n```bibtex\n@misc{kerasrecommenders2024,\n title={KerasRecommenders},\n author={Hertschuh, Fabien and Chollet, Fran\\c{c}ois and Sharma, Abheesht and others},\n year={2024},\n howpublished={\\url{https://github.com/keras-team/keras-rs}},\n}\n```\n\n## Acknowledgements\n\nThank you to all of our wonderful contributors!\n\n<a href=\"https://github.com/keras-team/keras-rs/graphs/contributors\">\n <img src=\"https://contrib.rocks/image?repo=keras-team/keras-rs\" />\n</a>\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Multi-backend recommender systems with Keras 3.",
"version": "0.0.1.dev2025022503",
"project_urls": {
"Home": "https://keras.io/",
"Repository": "https://github.com/keras-team/keras-rs"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c58cb4ebd4d8151e6c5ef133ece924077ae74ccf9114dee39d1065d66fea2e81",
"md5": "de439158ab12f2bf787cbf642de6d5d2",
"sha256": "c7e5cacd8c94409ddf286a972721612a605f53b5ef6f780e6234860fbc8cd2b6"
},
"downloads": -1,
"filename": "keras_rs_nightly-0.0.1.dev2025022503-py3-none-any.whl",
"has_sig": false,
"md5_digest": "de439158ab12f2bf787cbf642de6d5d2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 13744,
"upload_time": "2025-02-25T03:15:18",
"upload_time_iso_8601": "2025-02-25T03:15:18.983142Z",
"url": "https://files.pythonhosted.org/packages/c5/8c/b4ebd4d8151e6c5ef133ece924077ae74ccf9114dee39d1065d66fea2e81/keras_rs_nightly-0.0.1.dev2025022503-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "5fab3abbadc975e2a37ba4e423357243f880b60a2440675cc049f79ad49a1ec1",
"md5": "7ae429de353bb6ab53ada54643949e54",
"sha256": "02e7136d13d67c568315180e9938bca8aaff7f9c82b14b80372f7b4dd8b0504d"
},
"downloads": -1,
"filename": "keras_rs_nightly-0.0.1.dev2025022503.tar.gz",
"has_sig": false,
"md5_digest": "7ae429de353bb6ab53ada54643949e54",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 12300,
"upload_time": "2025-02-25T03:15:20",
"upload_time_iso_8601": "2025-02-25T03:15:20.798815Z",
"url": "https://files.pythonhosted.org/packages/5f/ab/3abbadc975e2a37ba4e423357243f880b60a2440675cc049f79ad49a1ec1/keras_rs_nightly-0.0.1.dev2025022503.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-25 03:15:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "keras-team",
"github_project": "keras-rs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "keras-rs-nightly"
}
JSON
