# Symphony Summary Widget
A component that displays an overview of the provided dataset table.
To configure it, pass a list of `SummaryElement`.
One `SummaryElement` is defined as:
```
export interface SummaryElement {
name: string;
data: number | ChartData;
}
```
`ChartData` is defined as:
```
export interface ChartData {
spec: VegaLiteSpec;
data: Record<string, unknown>;
}
```
## Installation
```bash
pip install symphony_summary
```
## Usage
To learn how to use Symphony, see the [documentation](https://apple.github.io/ml-symphony/).
## Development
To learn about how to build Symphony from source and how to contribute to the framework, please look at [CONTRIBUTING.md](../CONTRIBUTING.md) and the [development documentation](https://apple.github.io/ml-symphony/contributing.html).
Raw data
{
"_id": null,
"home_page": "https://github.com/apple/ml-symphony",
"name": "symphony-summary",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "Jupyter,Widgets,IPython",
"author": "Apple",
"author_email": "dnikit-symphony-oss@group.apple.com",
"download_url": "https://files.pythonhosted.org/packages/61/95/d6bbb5f28b76f1cd517e605476dcb0e7953b4ddd93f4b3df75854b208c29/symphony_summary-1.0.2.tar.gz",
"platform": "Linux",
"description": "# Symphony Summary Widget\n\nA component that displays an overview of the provided dataset table.\nTo configure it, pass a list of `SummaryElement`.\nOne `SummaryElement` is defined as:\n\n```\nexport interface SummaryElement {\n name: string;\n data: number | ChartData;\n}\n```\n\n`ChartData` is defined as:\n\n```\nexport interface ChartData {\n spec: VegaLiteSpec;\n data: Record<string, unknown>;\n}\n```\n\n## Installation\n\n```bash\npip install symphony_summary\n```\n\n## Usage\n\nTo learn how to use Symphony, see the [documentation](https://apple.github.io/ml-symphony/).\n\n## Development\n\nTo learn about how to build Symphony from source and how to contribute to the framework, please look at [CONTRIBUTING.md](../CONTRIBUTING.md) and the [development documentation](https://apple.github.io/ml-symphony/contributing.html).\n",
"bugtrack_url": null,
"license": "Apple Sample Code License",
"summary": "A Symphony component that visualizes an overview of a dataset",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/apple/ml-symphony"
},
"split_keywords": [
"jupyter",
"widgets",
"ipython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d205712d5787c8cb7536f4eb5dd69b9c79526fd4dea2bdf7d500f5c2491137e5",
"md5": "11d7d428f89d5acc1687064328ba5488",
"sha256": "53bcb80820aa4392caff27b89130b73e1de913c2442584f5e9d353d36de5a53c"
},
"downloads": -1,
"filename": "symphony_summary-1.0.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "11d7d428f89d5acc1687064328ba5488",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 11410783,
"upload_time": "2023-08-08T22:05:04",
"upload_time_iso_8601": "2023-08-08T22:05:04.551354Z",
"url": "https://files.pythonhosted.org/packages/d2/05/712d5787c8cb7536f4eb5dd69b9c79526fd4dea2bdf7d500f5c2491137e5/symphony_summary-1.0.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6195d6bbb5f28b76f1cd517e605476dcb0e7953b4ddd93f4b3df75854b208c29",
"md5": "8120669a5e6265f0e9cf60e4c95f32d8",
"sha256": "624c24272c5d7ac9dd778962c23e2006e7f0aebf84c1e1fcf7c783836a41e9db"
},
"downloads": -1,
"filename": "symphony_summary-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "8120669a5e6265f0e9cf60e4c95f32d8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6534312,
"upload_time": "2023-08-08T22:05:07",
"upload_time_iso_8601": "2023-08-08T22:05:07.481512Z",
"url": "https://files.pythonhosted.org/packages/61/95/d6bbb5f28b76f1cd517e605476dcb0e7953b4ddd93f4b3df75854b208c29/symphony_summary-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-08 22:05:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "apple",
"github_project": "ml-symphony",
"github_not_found": true,
"lcname": "symphony-summary"
}
JSON
