| Name | divisi-toolkit JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | None |
| Summary | Interactive widget and toolkit for slice discovery |
| upload_time | 2024-06-26 19:42:00 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2024 CMU Data Interaction Group 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 |
ai
machine learning
notebook
jupyter
data science
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Divisi - Interactive Slice Finding
## Demo Quickstart
Optionally create a virtual environment with Python >3.7 to run the demo.
Install the package:
```bash
pip install divisi-toolkit
```
Install Jupyter Notebook or Jupyter Lab if not already installed. Then start a
Jupyter server. The `example_data/example_adult.ipynb` notebook shows how to use
the slice finding widget.
## Running in Development Mode
To develop the frontend, make sure you have an up-to-date version of NodeJS in
your terminal, then run:
```bash
cd client
npm install
vite
```
The `vite` command starts a live hot-reload server for the frontend. Then, when
you initialize the `SliceFinderWidget`, pass the `dev=True` keyword argument to
use the live server. (Make sure that you don't have anything else running on
port 5173 while you do this.)
Raw data
{
"_id": null,
"home_page": null,
"name": "divisi-toolkit",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "AI, machine learning, notebook, jupyter, data science",
"author": null,
"author_email": "Venkatesh Sivaraman <venkats@cmu.edu>",
"download_url": "https://files.pythonhosted.org/packages/8e/34/79e92391914e62f5d35b2ff5fb18ebf5df29768eeb6f68e7d413609f45a0/divisi_toolkit-0.1.2.tar.gz",
"platform": null,
"description": "# Divisi - Interactive Slice Finding\n\n## Demo Quickstart\n\nOptionally create a virtual environment with Python >3.7 to run the demo.\n\nInstall the package:\n\n```bash\npip install divisi-toolkit\n```\n\nInstall Jupyter Notebook or Jupyter Lab if not already installed. Then start a\nJupyter server. The `example_data/example_adult.ipynb` notebook shows how to use\nthe slice finding widget.\n\n## Running in Development Mode\n\nTo develop the frontend, make sure you have an up-to-date version of NodeJS in\nyour terminal, then run:\n\n```bash\ncd client\nnpm install\nvite\n```\n\nThe `vite` command starts a live hot-reload server for the frontend. Then, when\nyou initialize the `SliceFinderWidget`, pass the `dev=True` keyword argument to\nuse the live server. (Make sure that you don't have anything else running on\nport 5173 while you do this.)\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 CMU Data Interaction Group 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.",
"summary": "Interactive widget and toolkit for slice discovery",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/cmudig/divisi-toolkit"
},
"split_keywords": [
"ai",
" machine learning",
" notebook",
" jupyter",
" data science"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "570832d8bfa11a0c7b6cbcea143be05e6bf1ab63d05ac7de6c958f2fa2302757",
"md5": "00d50f502ee19e3fedc6f2e1c6589977",
"sha256": "0c535657c19bf18ce697fb2c9a307a0cd336ab0761b262809a9314c1195b7108"
},
"downloads": -1,
"filename": "divisi_toolkit-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "00d50f502ee19e3fedc6f2e1c6589977",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 205898,
"upload_time": "2024-06-26T19:41:58",
"upload_time_iso_8601": "2024-06-26T19:41:58.584571Z",
"url": "https://files.pythonhosted.org/packages/57/08/32d8bfa11a0c7b6cbcea143be05e6bf1ab63d05ac7de6c958f2fa2302757/divisi_toolkit-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8e3479e92391914e62f5d35b2ff5fb18ebf5df29768eeb6f68e7d413609f45a0",
"md5": "72893c23d109b21564c209882ba275ae",
"sha256": "f2278fdc089ec8b65e81337cbbf3ede4e4b6833ade4d59789a67702c3fd9c81d"
},
"downloads": -1,
"filename": "divisi_toolkit-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "72893c23d109b21564c209882ba275ae",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 1314842,
"upload_time": "2024-06-26T19:42:00",
"upload_time_iso_8601": "2024-06-26T19:42:00.572697Z",
"url": "https://files.pythonhosted.org/packages/8e/34/79e92391914e62f5d35b2ff5fb18ebf5df29768eeb6f68e7d413609f45a0/divisi_toolkit-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-26 19:42:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cmudig",
"github_project": "divisi-toolkit",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "divisi-toolkit"
}
