# Streamsight
The purpose of this Final Year Project is to design and implement a toolkit for
evaluating Recommendation System (RecSys) which respects the temporal aspect
during the data splitting process and incrementally release data as close
to a live production setting as possible. We aim to achieve this through
provision of API for the programmer to interact with the objects in the library.
[](https://pypi.org/project/streamsight/)
[](https://hiiamtzekean.github.io/Streamsight/)
[](https://www.python.org/downloads/)
## Table of Contents
- [Streamsight](#streamsight)
- [Table of Contents](#table-of-contents)
- [Installation with Github](#installation-with-github)
- [Installation through poetry](#installation-through-poetry)
- [Installation through pip](#installation-through-pip)
- [Installation with PyPI](#installation-with-pypi)
- [Documentation](#documentation)
## Installation with Github
The package can be installed quickly with python `poetry` or the traditional `pip`
method. The recommended way of installation would be through `poetry` as it will
help install the dependencies along with the package. We assume that the repository
has already been cloned else you can run the following code on terminal before
continuing.
```shell
git clone https://github.com/HiIAmTzeKean/Streamsight.git
cd Streamsight
```
### Installation through poetry
The following code assumes that you do not have `poetry` installed yet. If you
using MacOS, you might want to consider installing `poetry` with homebrew instead.
```shell
pip install poetry
# MacOS can consider using brew install poetry
poetry install
```
### Installation through pip
The following code below assumes that you have `pip` installed and is in system
PATH.
```shell
pip install -e .
```
## Installation with PyPI
Alternatively `streamsight` is available on PyPi and can be installed through
either of the commands below. The link to PyPI can be found
[here](https://pypi.org/project/streamsight/).
```shell
# To install via pip
pip install streamsight
# To install with streamsight as a dependency
poetry add streamsight
```
## Documentation
The documentation can be found [here](https://hiiamtzekean.github.io/Streamsight/)
and [repository](https://github.com/HiIAmTzeKean/Streamsight) on Github.
Raw data
{
"_id": null,
"home_page": "https://github.com/HiIAmTzeKean/Streamsight",
"name": "streamsight",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": "RecSys, toolkit, streamsight",
"author": "Ng Tze Kean",
"author_email": "ngtzekean@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/23/65/a4bfbe5a1be56fa544a2cc64a28f004580ac352081f476315ed1f86fd011/streamsight-0.2.11.tar.gz",
"platform": null,
"description": "# Streamsight\n\n\n\nThe purpose of this Final Year Project is to design and implement a toolkit for\nevaluating Recommendation System (RecSys) which respects the temporal aspect\nduring the data splitting process and incrementally release data as close\nto a live production setting as possible. We aim to achieve this through\nprovision of API for the programmer to interact with the objects in the library.\n\n[](https://pypi.org/project/streamsight/) \n[](https://hiiamtzekean.github.io/Streamsight/) \n[](https://www.python.org/downloads/)\n\n## Table of Contents\n- [Streamsight](#streamsight)\n - [Table of Contents](#table-of-contents)\n - [Installation with Github](#installation-with-github)\n - [Installation through poetry](#installation-through-poetry)\n - [Installation through pip](#installation-through-pip)\n - [Installation with PyPI](#installation-with-pypi)\n - [Documentation](#documentation)\n\n\n## Installation with Github\n\nThe package can be installed quickly with python `poetry` or the traditional `pip`\nmethod. The recommended way of installation would be through `poetry` as it will\nhelp install the dependencies along with the package. We assume that the repository\nhas already been cloned else you can run the following code on terminal before\ncontinuing.\n\n```shell\ngit clone https://github.com/HiIAmTzeKean/Streamsight.git\ncd Streamsight\n```\n\n### Installation through poetry\n\nThe following code assumes that you do not have `poetry` installed yet. If you\nusing MacOS, you might want to consider installing `poetry` with homebrew instead.\n\n```shell\npip install poetry\n# MacOS can consider using brew install poetry\npoetry install\n```\n\n### Installation through pip\n\nThe following code below assumes that you have `pip` installed and is in system\nPATH.\n\n```shell\npip install -e .\n```\n\n## Installation with PyPI\n\nAlternatively `streamsight` is available on PyPi and can be installed through\neither of the commands below. The link to PyPI can be found\n[here](https://pypi.org/project/streamsight/).\n\n```shell\n# To install via pip\npip install streamsight\n\n# To install with streamsight as a dependency\npoetry add streamsight\n```\n\n## Documentation\n\nThe documentation can be found [here](https://hiiamtzekean.github.io/Streamsight/)\nand [repository](https://github.com/HiIAmTzeKean/Streamsight) on Github.",
"bugtrack_url": null,
"license": null,
"summary": "A toolkit for offline evaluation of Recommender Systems",
"version": "0.2.11",
"project_urls": {
"Documentation": "https://hiiamtzekean.github.io/Streamsight/",
"Homepage": "https://github.com/HiIAmTzeKean/Streamsight",
"Repository": "https://github.com/HiIAmTzeKean/Streamsight"
},
"split_keywords": [
"recsys",
" toolkit",
" streamsight"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6d68b77bca1cab78379868e7a6bf51bf58a89147a4d73cc6ce39b7e5702b0667",
"md5": "82cf0189673dd462a40d182b28f9ff37",
"sha256": "cfd76413a62019f1f7c749fe094a34b37f619c7e20aa9e5bf4be9ff39f42d8c0"
},
"downloads": -1,
"filename": "streamsight-0.2.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "82cf0189673dd462a40d182b28f9ff37",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 82700,
"upload_time": "2024-10-28T11:35:19",
"upload_time_iso_8601": "2024-10-28T11:35:19.369615Z",
"url": "https://files.pythonhosted.org/packages/6d/68/b77bca1cab78379868e7a6bf51bf58a89147a4d73cc6ce39b7e5702b0667/streamsight-0.2.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2365a4bfbe5a1be56fa544a2cc64a28f004580ac352081f476315ed1f86fd011",
"md5": "695214b5057519a6a40a9a8e8a4c47c4",
"sha256": "d51491777272496f3cb4d268265bd8295a9c27daec41fef1f66dba359e15c725"
},
"downloads": -1,
"filename": "streamsight-0.2.11.tar.gz",
"has_sig": false,
"md5_digest": "695214b5057519a6a40a9a8e8a4c47c4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 227521,
"upload_time": "2024-10-28T11:35:21",
"upload_time_iso_8601": "2024-10-28T11:35:21.901736Z",
"url": "https://files.pythonhosted.org/packages/23/65/a4bfbe5a1be56fa544a2cc64a28f004580ac352081f476315ed1f86fd011/streamsight-0.2.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-28 11:35:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "HiIAmTzeKean",
"github_project": "Streamsight",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "streamsight"
}
JSON
