| Name | insight JSON |
| Version |
1.0
JSON |
| download |
| home_page | None |
| Summary | A python library for monitoring, comparing and extracting insights from data. |
| upload_time | 2024-04-02 09:38:12 |
| maintainer | None |
| docs_url | https://pythonhosted.org/insight/ |
| author | None |
| requires_python | >=3.8 |
| license | BSD 3-Clause License |
| keywords |
metrics
data
evaluation
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 🧿 insight
A python package to quickly **understand**, **assess**, and **compare** pandas `Series`/`DataFrames`.
The predominant functions in the package focus on easy-to-use **metrics** and intelligent **plotting functions**. The metrics can also be configured from YAML to allow for simple to configure benchmarking and assessment scripts.
## [](https://pypi.org/project/insight/) [](https://github.com/synthesized-io/insight/actions/workflows/code-ql.yml) [](https://github.com/synthesized-io/insight/actions/workflows/CI.yaml) [](https://sonarcloud.io/summary/new_code?id=synthesized-io_synthesized-insight) [](https://sonarcloud.io/summary/new_code?id=synthesized-io_synthesized-insight) [](https://results.pre-commit.ci/latest/github/synthesized-io/insight/master)
## Installation
```shell
pip install insight
```
## Usage
### Metrics
At the core of insight are the metrics classes which can be evaluated on one series, two series,
one dataframe or two dataframes.
```pycon
>>> import insight.metrics as m
>>> metric = m.EarthMoversDistance()
>>> metric(df['A'], df['B'])
0.14
```
### Plotting
The package provides various plotting functions which allow you to easily explore any series, dataframe
or multiple dataframes.
```pycon
>>> import insight.plotting as p
>>> p.plot_dataset([df1, df2])
```
### Migrations
`insight` populates the results to the Postgres database configured by environment variables. To run migrations against it, simply:
```bash
insight-migrations
```
<div align="center">
<img alt="distribution plots" src="https://user-images.githubusercontent.com/13236749/181318624-95ad8702-5113-4a9e-8dd4-32f4a3dc8c9f.png" width="85%">
</div>
Raw data
{
"_id": null,
"home_page": null,
"name": "insight",
"maintainer": null,
"docs_url": "https://pythonhosted.org/insight/",
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "metrics, data, evaluation",
"author": null,
"author_email": "\"Synthesized Ltd.\" <ml@synthesized.io>, Daniel Sabanov <daniel@sadogursky.com>, Simon Swan <shk.swan@gmail.com>",
"download_url": null,
"platform": "MacOS",
"description": "# \ud83e\uddff insight\n\n\n\n\n\n\nA python package to quickly **understand**, **assess**, and **compare** pandas `Series`/`DataFrames`.\n\nThe predominant functions in the package focus on easy-to-use **metrics** and intelligent **plotting functions**. The metrics can also be configured from YAML to allow for simple to configure benchmarking and assessment scripts.\n\n\n## [](https://pypi.org/project/insight/) [](https://github.com/synthesized-io/insight/actions/workflows/code-ql.yml) [](https://github.com/synthesized-io/insight/actions/workflows/CI.yaml) [](https://sonarcloud.io/summary/new_code?id=synthesized-io_synthesized-insight) [](https://sonarcloud.io/summary/new_code?id=synthesized-io_synthesized-insight) [](https://results.pre-commit.ci/latest/github/synthesized-io/insight/master)\n\n\n## Installation\n\n```shell\npip install insight\n```\n\n## Usage\n\n### Metrics\n\nAt the core of insight are the metrics classes which can be evaluated on one series, two series,\none dataframe or two dataframes.\n\n```pycon\n>>> import insight.metrics as m\n>>> metric = m.EarthMoversDistance()\n>>> metric(df['A'], df['B'])\n0.14\n```\n\n### Plotting\n\nThe package provides various plotting functions which allow you to easily explore any series, dataframe\nor multiple dataframes.\n\n```pycon\n>>> import insight.plotting as p\n>>> p.plot_dataset([df1, df2])\n```\n\n### Migrations\n\n`insight` populates the results to the Postgres database configured by environment variables. To run migrations against it, simply:\n\n```bash\ninsight-migrations\n```\n\n<div align=\"center\">\n<img alt=\"distribution plots\" src=\"https://user-images.githubusercontent.com/13236749/181318624-95ad8702-5113-4a9e-8dd4-32f4a3dc8c9f.png\" width=\"85%\">\n</div>\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License",
"summary": "A python library for monitoring, comparing and extracting insights from data.",
"version": "1.0",
"project_urls": {
"documentation": "https://docs.synthesized.io/",
"homepage": "https://github.com/synthesized-io/insight",
"repository": "https://github.com/synthesized-io/insight"
},
"split_keywords": [
"metrics",
" data",
" evaluation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "94b733dadf77f630edf1c070c5807fc0dec31783cebeaea4633ba581c1ca0541",
"md5": "480d2f0187db29dbbcebdc828bf935f1",
"sha256": "c6058fdf8d0701f7d6f7c3dd7b017a514eb8d0493929a3a6a62a22260b56cbb2"
},
"downloads": -1,
"filename": "insight-1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "480d2f0187db29dbbcebdc828bf935f1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 143744,
"upload_time": "2024-04-02T09:38:12",
"upload_time_iso_8601": "2024-04-02T09:38:12.540750Z",
"url": "https://files.pythonhosted.org/packages/94/b7/33dadf77f630edf1c070c5807fc0dec31783cebeaea4633ba581c1ca0541/insight-1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-02 09:38:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "synthesized-io",
"github_project": "insight",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "insight"
}
