Add requirements.txt, .gitignore, setup.py and github actions. (#5)

Author: hertschuh

.github/workflows/actions.yml

@@ -0,0 +1,83 @@
+name: Tests
+
+on:
+  push:
+  pull_request:
+  workflow_call:
+  release:
+    types: [created]
+
+permissions:
+  contents: read
+
+jobs:
+  run_tests:
+    name: Test the code
+    strategy:
+      fail-fast: false
+      matrix:
+        backend: [tensorflow, jax, torch]
+    runs-on: ubuntu-latest
+    env:
+      KERAS_BACKEND: ${{ matrix.backend }}
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.9
+    - name: Get pip cache dir
+      id: pip-cache
+      run: |
+        python -m pip install --upgrade pip setuptools
+        echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
+    - name: pip cache
+      uses: actions/cache@v4
+      with:
+        path: ${{ steps.pip-cache.outputs.dir }}
+        key: ${{ runner.os }}-pip-${{ hashFiles('setup.py') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+    - name: Install dependencies
+      run: |
+          pip install -r requirements.txt --progress-bar off
+          pip install --no-deps -e "." --progress-bar off
+    - name: Test with pytest
+      run: |
+        pytest keras_rs/
+  check_format:
+    name: Check the code format
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.9
+      - name: Get pip cache dir
+        id: pip-cache
+        run: |
+          python -m pip install --upgrade pip setuptools
+          echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
+      - name: pip cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('setup.py') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - name: Install dependencies
+        run: |
+          pip install -r requirements.txt --progress-bar off
+          pip install --no-deps -e "." --progress-bar off
+      - name: Lint
+        run: bash shell/lint.sh
+      - name: Check for API changes
+        run: |
+          bash shell/api_gen.sh
+          git status
+          clean=$(git status | grep "nothing to commit")
+          if [ -z "$clean" ]; then
+            echo "Please run shell/api_gen.sh to generate API."
+            exit 1
+          fi

.gitignore

@@ -0,0 +1,22 @@
+# Python temp files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Vim temp files
+*.swp
+*.swo
+
+*.egg-info/
+dist/
+
+.coverage
+.coverage.*
+
+# Windows-specific build files
+build/
+
+# Pycharm files
+.idea/
+
+venv/

requirements-common.txt

@@ -0,0 +1,20 @@
+# api generation
+namex>=0.0.8
+
+# formatting and linting
+black>=22
+flake8
+isort
+mypy
+
+# testing
+absl-py
+pytest
+pytest-cov
+numpy
+
+# pip build
+build
+
+# keras
+keras

requirements-jax-cuda.txt

@@ -0,0 +1,14 @@
+# Tensorflow cpu-only version.
+tensorflow-cpu
+
+# Torch cpu-only version.
+--extra-index-url https://download.pytorch.org/whl/cpu
+torch>=2.1.0
+torchvision>=0.16.0
+
+# Jax with cuda support.
+# Keep same version as Keras repo.
+--find-links https://storage.googleapis.com/jax-releases/jax_cuda_releases.html
+jax[cuda12_pip]==0.4.28
+
+-r requirements-common.txt

requirements-tensorflow-cuda.txt

@@ -0,0 +1,12 @@
+# Tensorflow with cuda support.
+tensorflow[and-cuda]~=2.17.0
+
+# Torch cpu-only version.
+--extra-index-url https://download.pytorch.org/whl/cpu
+torch>=2.1.0
+torchvision>=0.16.0
+
+# Jax cpu-only version.
+jax[cpu]
+
+-r requirements-common.txt

requirements-torch-cuda.txt

@@ -0,0 +1,12 @@
+# Tensorflow cpu-only version.
+tensorflow-cpu~=2.17
+
+# Torch with cuda support.
+--extra-index-url https://download.pytorch.org/whl/cu121
+torch==2.4.1+cu121
+torchvision==0.19.1+cu121
+
+# Jax cpu-only version.
+jax[cpu]
+
+-r requirements-common.txt

requirements.txt

@@ -0,0 +1,12 @@
+# Tensorflow.
+tensorflow-cpu~=2.17
+
+# Torch.
+--extra-index-url https://download.pytorch.org/whl/cpu
+torch>=2.1.0
+torchvision>=0.16.0
+
+# Jax.
+jax[cpu]
+
+-r requirements-common.txt

setup.py

@@ -0,0 +1,58 @@
+"""Setup script."""
+
+import os
+import pathlib
+
+from setuptools import find_packages
+from setuptools import setup
+
+
+def read(rel_path: str) -> str:
+    here = os.path.abspath(os.path.dirname(__file__))
+    with open(os.path.join(here, rel_path)) as fp:
+        return fp.read()
+
+
+def get_version(rel_path: str) -> str:
+    for line in read(rel_path).splitlines():
+        if line.startswith("__version__"):
+            delim = '"' if '"' in line else "'"
+            return line.split(delim)[1]
+    raise RuntimeError("Unable to find version string.")
+
+
+HERE = pathlib.Path(__file__).parent
+README = (HERE / "README.md").read_text()
+VERSION = get_version("keras_rs/src/version_utils.py")
+
+setup(
+    name="keras-rs",
+    description=("Multi-backend recommender systems with Keras 3."),
+    long_description=README,
+    long_description_content_type="text/markdown",
+    version=VERSION,
+    url="https://github.com/keras-team/keras-rs",
+    author="Keras team",
+    author_email="[email protected]",
+    license="Apache License 2.0",
+    install_requires=[
+        "keras",
+    ],
+    # Supported Python versions
+    python_requires=">=3.9",
+    classifiers=[
+        "Development Status :: 3 - Alpha",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3 :: Only",
+        "Operating System :: Unix",
+        "Operating System :: Microsoft :: Windows",
+        "Operating System :: MacOS",
+        "Intended Audience :: Science/Research",
+        "Topic :: Scientific/Engineering",
+        "Topic :: Software Development",
+    ],
+    packages=find_packages(),  # exclude=("keras_rs.src.testing",)),
+)