fastEASE


NamefastEASE JSON
Version 0.3.3 PyPI version JSON
download
home_pageNone
SummaryAn easy-to-use Python library for building EASE recommendation systems with CUDA
upload_time2025-02-17 12:51:35
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT License Copyright (c) 2025 Hassan Abedi Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords recsys recommendation systems machine learning ai personalization
VCS
bugtrack_url
requirements build exceptiongroup fastrlock iniconfig joblib numpy packaging pluggy pyproject_hooks pytest scikit-learn scipy threadpoolctl tomli tqdm
Travis-CI No Travis.
coveralls test coverage
            # fast EASE for CUDA
[![Python version](https://img.shields.io/badge/Python-%3E=3.10-blue)](https://github.com/fkrasnov2/fastEASE)

##
**EASY** is a unique and decisive approach to recommendation for a limited number of users and items.
One challenge is that the matrix inversion process becomes computationally intensive, requiring significant processing time on the central processing unit (CPU).
This issue is addressed in the current project by leveraging CUDA, a powerful technology specifically designed for parallel processing. The key distinction is that this solution is intended not for research purposes but rather for deployment in production environments.

## Framework

![Framework](https://media.githubusercontent.com/media/fkrasnov2/fastEASE/main/fastEASEv2.png)

## Structure

- `.github`: GitHub Actions workflows.
- `src`: Library's source code.
- `tests`: Unit tests.
- `.editorconfig`: Editor settings for consistent coding style.
- `.gitignore`: Excludes files generated by Python and Poetry.
- `LICENSE`: License file.
- `Makefile`: Manage tasks like testing, linting, and formatting.
- `pyproject.toml`: PyPi's configuration file.

## Getting Started
bash:
```console
pip install fastEASE
mkdir dataset
wget --no-check-certificate https://files.grouplens.org/datasets/movielens/ml-1m.zip -O dataset/ml-1m.zip
unzip dataset/ml-1m.zip -d dataset/
```
python:
```python
k = 5
pipeline = PipelineEASE(
    user_item_it=DatasetML1M.load_interactions(
        "dataset/ml-1m"
    ),
    min_item_freq=1,
    min_user_interactions_len=5,
    max_user_interactions_len=32,
    calc_ndcg_at_k=True,
    k=k,
    predict_next_n=False,
)
print(f"nDCG@{k} = {pipeline.ndcg:.4}")

```

### Prerequisites

- `Python` >= 3.10
- `GNU Make`

Tested on `Ubuntu 24.04 LTS` and `Debian 12`. But the template should work on other operating systems as well.

### Setting Things Up

1. **Clone the repository**:

    ```sh
    git clone https://github.com/fkrasnov2/fastEASE
    cd fastEASE
    ```

2. **Install dependencies**:
    ```sh
    make install
    ```

### Development Workflow Management
```sh
# Run the unit tests
make test
```

```sh
# Lint the code
make lint
```



            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "fastEASE",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "recsys, recommendation systems, machine learning, AI, personalization",
    "author": null,
    "author_email": "Fedor Krasnov <krasnov.fedor2@wb.ru>",
    "download_url": "https://files.pythonhosted.org/packages/b4/2b/0d49246c00f675c41d6374dfbd2e6e92d1eb7a2b6c5e9eed1b20b79964d0/fastease-0.3.3.tar.gz",
    "platform": null,
    "description": "# fast EASE for CUDA\n[![Python version](https://img.shields.io/badge/Python-%3E=3.10-blue)](https://github.com/fkrasnov2/fastEASE)\n\n##\n**EASY** is a unique and decisive approach to recommendation for a limited number of users and items.\nOne challenge is that the matrix inversion process becomes computationally intensive, requiring significant processing time on the central processing unit (CPU).\nThis issue is addressed in the current project by leveraging CUDA, a powerful technology specifically designed for parallel processing. The key distinction is that this solution is intended not for research purposes but rather for deployment in production environments.\n\n## Framework\n\n![Framework](https://media.githubusercontent.com/media/fkrasnov2/fastEASE/main/fastEASEv2.png)\n\n## Structure\n\n- `.github`: GitHub Actions workflows.\n- `src`: Library's source code.\n- `tests`: Unit tests.\n- `.editorconfig`: Editor settings for consistent coding style.\n- `.gitignore`: Excludes files generated by Python and Poetry.\n- `LICENSE`: License file.\n- `Makefile`: Manage tasks like testing, linting, and formatting.\n- `pyproject.toml`: PyPi's configuration file.\n\n## Getting Started\nbash:\n```console\npip install fastEASE\nmkdir dataset\nwget --no-check-certificate https://files.grouplens.org/datasets/movielens/ml-1m.zip -O dataset/ml-1m.zip\nunzip dataset/ml-1m.zip -d dataset/\n```\npython:\n```python\nk = 5\npipeline = PipelineEASE(\n    user_item_it=DatasetML1M.load_interactions(\n        \"dataset/ml-1m\"\n    ),\n    min_item_freq=1,\n    min_user_interactions_len=5,\n    max_user_interactions_len=32,\n    calc_ndcg_at_k=True,\n    k=k,\n    predict_next_n=False,\n)\nprint(f\"nDCG@{k} = {pipeline.ndcg:.4}\")\n\n```\n\n### Prerequisites\n\n- `Python` >= 3.10\n- `GNU Make`\n\nTested on `Ubuntu 24.04 LTS` and `Debian 12`. But the template should work on other operating systems as well.\n\n### Setting Things Up\n\n1. **Clone the repository**:\n\n    ```sh\n    git clone https://github.com/fkrasnov2/fastEASE\n    cd fastEASE\n    ```\n\n2. **Install dependencies**:\n    ```sh\n    make install\n    ```\n\n### Development Workflow Management\n```sh\n# Run the unit tests\nmake test\n```\n\n```sh\n# Lint the code\nmake lint\n```\n\n\n",
    "bugtrack_url": null,
    "license": "MIT License\n        \n        Copyright (c) 2025 Hassan Abedi\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy\n        of this software and associated documentation files (the \"Software\"), to deal\n        in the Software without restriction, including without limitation the rights\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n        copies of the Software, and to permit persons to whom the Software is\n        furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n        SOFTWARE.\n        ",
    "summary": "An easy-to-use Python library for building EASE recommendation systems with CUDA",
    "version": "0.3.3",
    "project_urls": {
        "Homepage": "https://github.com/fkrasnov2/fastEASE",
        "Repository": "https://github.com/fkrasnov2/fastEASE"
    },
    "split_keywords": [
        "recsys",
        " recommendation systems",
        " machine learning",
        " ai",
        " personalization"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "cbb18dd71e748d15e6f1a047dfc591f73ee8b6b77354ac0d66dafa1097989866",
                "md5": "620040280467c3c60924dabbe9ebefa2",
                "sha256": "8a70a8a4be87f9a2e5e787905e6cf3b51c3c1ae2a56dbeefda068fd6ee9fe464"
            },
            "downloads": -1,
            "filename": "fastEASE-0.3.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "620040280467c3c60924dabbe9ebefa2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 6964,
            "upload_time": "2025-02-17T12:51:33",
            "upload_time_iso_8601": "2025-02-17T12:51:33.576178Z",
            "url": "https://files.pythonhosted.org/packages/cb/b1/8dd71e748d15e6f1a047dfc591f73ee8b6b77354ac0d66dafa1097989866/fastEASE-0.3.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b42b0d49246c00f675c41d6374dfbd2e6e92d1eb7a2b6c5e9eed1b20b79964d0",
                "md5": "e78e6a33a946b9a9ee2fe6a3e4873f1d",
                "sha256": "39f2153a327edfe0be43104a4275dffe98d3b37ea4663d3016fb13fb96f9e290"
            },
            "downloads": -1,
            "filename": "fastease-0.3.3.tar.gz",
            "has_sig": false,
            "md5_digest": "e78e6a33a946b9a9ee2fe6a3e4873f1d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 8722,
            "upload_time": "2025-02-17T12:51:35",
            "upload_time_iso_8601": "2025-02-17T12:51:35.395951Z",
            "url": "https://files.pythonhosted.org/packages/b4/2b/0d49246c00f675c41d6374dfbd2e6e92d1eb7a2b6c5e9eed1b20b79964d0/fastease-0.3.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-17 12:51:35",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "fkrasnov2",
    "github_project": "fastEASE",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [
        {
            "name": "build",
            "specs": [
                [
                    "==",
                    "1.2.2.post1"
                ]
            ]
        },
        {
            "name": "exceptiongroup",
            "specs": [
                [
                    "==",
                    "1.2.2"
                ]
            ]
        },
        {
            "name": "fastrlock",
            "specs": [
                [
                    "==",
                    "0.8.3"
                ]
            ]
        },
        {
            "name": "iniconfig",
            "specs": [
                [
                    "==",
                    "2.0.0"
                ]
            ]
        },
        {
            "name": "joblib",
            "specs": [
                [
                    "==",
                    "1.4.2"
                ]
            ]
        },
        {
            "name": "numpy",
            "specs": [
                [
                    "==",
                    "2.2.2"
                ]
            ]
        },
        {
            "name": "packaging",
            "specs": [
                [
                    "==",
                    "24.2"
                ]
            ]
        },
        {
            "name": "pluggy",
            "specs": [
                [
                    "==",
                    "1.5.0"
                ]
            ]
        },
        {
            "name": "pyproject_hooks",
            "specs": [
                [
                    "==",
                    "1.2.0"
                ]
            ]
        },
        {
            "name": "pytest",
            "specs": [
                [
                    "==",
                    "8.3.4"
                ]
            ]
        },
        {
            "name": "scikit-learn",
            "specs": [
                [
                    "==",
                    "1.6.1"
                ]
            ]
        },
        {
            "name": "scipy",
            "specs": [
                [
                    "==",
                    "1.15.1"
                ]
            ]
        },
        {
            "name": "threadpoolctl",
            "specs": [
                [
                    "==",
                    "3.5.0"
                ]
            ]
        },
        {
            "name": "tomli",
            "specs": [
                [
                    "==",
                    "2.2.1"
                ]
            ]
        },
        {
            "name": "tqdm",
            "specs": [
                [
                    "==",
                    "4.67.1"
                ]
            ]
        }
    ],
    "lcname": "fastease"
}
        
Elapsed time: 0.55389s