<p align="center"><img alt="subgroups logo" src="https://github.com/antoniolopezmc/subgroups/blob/master/docs/source/images/logo_small.png?raw=true"></p>
-----------------
# subgroups - A Python library for Subgroup Discovery
| | |
|---------------|---|
| **Tests** | [](https://dev.azure.com/conda-forge/feedstock-builds/_build/latest?definitionId=21954&branchName=main) |
| **Package** | [](https://pypi.org/project/subgroups/) [](https://anaconda.org/conda-forge/subgroups)|
| **Metadata** | [](https://github.com/antoniolopezmc/subgroups) [](https://webs.um.es/antoniolopezmc/) [](https://www.python.org/) [](https://github.com/antoniolopezmc/subgroups/blob/master/LICENSE)  [](https://www.um.es/subgroups/)|
## What is it?
`subgroups` is a public, accessible and open-source python library created to work with the Subgroup Discovery (SD) technique. This library implements the necessary components related to the SD technique and contains a collection of SD algorithms and other data analysis utilities.
## Quick install
The easiest way to obtain this library is from either [PyPI](https://pypi.org/) (the Python Package Index) or [Conda](https://docs.conda.io/).
### PyPI
For that, you can [view and download the package from its PyPI page](https://pypi.org/project/subgroups/) or directly install it by executing:
```shell
pip install subgroups
```
### Conda
For that, you can [view and download the package from its Anaconda.org page (conda-forge channel)](https://anaconda.org/conda-forge/subgroups) or directly install it by executing:
```shell
conda install -c conda-forge subgroups
```
## Testing
After installing the library, a collection of tests can be launched by executing:
```python
import subgroups.tests as st
st.run_all_tests()
```
These tests verify that the library is correctly installed and that all components, algorithms and features are properly working.
## Installing from source
The source code (latest development) is currently hosted on: https://github.com/antoniolopezmc/subgroups
Therefore, you need first to clone the repository:
```shell
git clone https://github.com/antoniolopezmc/subgroups.git
cd subgroups
```
After that, the library can be installed in *production mode* or in *develop mode*.
### Production mode
```shell
make install_prod
```
or
```shell
python -m pip install ./
```
or
```shell
pip install ./
```
This mode installs the library as normal, copying it to the standard Python site-packages directory.
### Develop mode
```shell
make install_dev
```
or
```shell
python -m pip install -e ./
```
or
```shell
pip install -e ./
```
This mode installs the library in editable mode, creating a link in the standard Python site-packages directory to the downloaded project directory (the current directory). See the [pip_install documentation](https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-e) for further details.
## Example of use of the algorithms
An example of use of each algorithm implemented in `subgroups` python library can be found in the `examples/algorithms` folder:
- [SDMap](https://github.com/antoniolopezmc/subgroups/blob/master/examples/algorithms/SDMap.ipynb)
- [SDMap*](https://github.com/antoniolopezmc/subgroups/blob/master/examples/algorithms/SDMapStar.ipynb)
- [VLSD](https://github.com/antoniolopezmc/subgroups/blob/master/examples/algorithms/VLSD.ipynb)
- [BSD-CBSD-CPBSD](https://github.com/antoniolopezmc/subgroups/blob/master/examples/algorithms/BSD-CBSD-CPBSD.ipynb)
- [QFinder](https://github.com/antoniolopezmc/subgroups/blob/master/examples/algorithms/QFinder.ipynb)
- [GMSL](https://github.com/antoniolopezmc/subgroups/blob/master/examples/algorithms/GMSL.ipynb)
- [DSLM](https://github.com/antoniolopezmc/subgroups/blob/master/examples/algorithms/DSLM.ipynb)
## Documentation
The official documentation is hosted on https://www.um.es/subgroups/
Additionally, the source code of the project contains a folder called `docs`, which includes the documentation of the library. This documentation can be also manually generated by executing:
```shell
cd docs
make build
```
or
```shell
cd docs
python clean.py source/project_files build
python -m pip install --upgrade sphinx
python -m pip install --upgrade sphinx-rtd-theme
python -m pip install --upgrade sphinx-autodoc-typehints
sphinx-apidoc -f -T -M -o source/project_files ../src/subgroups
sphinx-build -M html source build
```
The generated documentation will be located in the `build` subfolder.
Raw data
{
"_id": null,
"home_page": "https://github.com/antoniolopezmc/subgroups",
"name": "subgroups",
"maintainer": "Antonio L\u00f3pez Mart\u00ednez-Carrasco",
"docs_url": null,
"requires_python": ">=3.9.0",
"maintainer_email": "antoniolopezmc1995@gmail.com",
"keywords": "python, data-science, machine-learning, data-analysis, subgroups, subgroup-discovery",
"author": "Antonio L\u00f3pez Mart\u00ednez-Carrasco",
"author_email": "antoniolopezmc1995@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/db/35/e15d59a22f7802cd62d72cbda1a9d4dca1c15cdaccaa87d880005b63ec8d/subgroups-0.1.8.tar.gz",
"platform": "any",
"description": "<p align=\"center\"><img alt=\"subgroups logo\" src=\"https://github.com/antoniolopezmc/subgroups/blob/master/docs/source/images/logo_small.png?raw=true\"></p>\r\n\r\n-----------------\r\n\r\n# subgroups - A Python library for Subgroup Discovery\r\n\r\n| | |\r\n|---------------|---|\r\n| **Tests** | [](https://dev.azure.com/conda-forge/feedstock-builds/_build/latest?definitionId=21954&branchName=main) |\r\n| **Package** | [](https://pypi.org/project/subgroups/) [](https://anaconda.org/conda-forge/subgroups)|\r\n| **Metadata** | [](https://github.com/antoniolopezmc/subgroups) [](https://webs.um.es/antoniolopezmc/) [](https://www.python.org/) [](https://github.com/antoniolopezmc/subgroups/blob/master/LICENSE)  [](https://www.um.es/subgroups/)|\r\n\r\n## What is it?\r\n\r\n`subgroups` is a public, accessible and open-source python library created to work with the Subgroup Discovery (SD) technique. This library implements the necessary components related to the SD technique and contains a collection of SD algorithms and other data analysis utilities.\r\n\r\n## Quick install\r\n\r\nThe easiest way to obtain this library is from either [PyPI](https://pypi.org/) (the Python Package Index) or [Conda](https://docs.conda.io/).\r\n\r\n### PyPI\r\n\r\nFor that, you can [view and download the package from its PyPI page](https://pypi.org/project/subgroups/) or directly install it by executing:\r\n\r\n```shell\r\npip install subgroups\r\n```\r\n\r\n### Conda\r\n\r\nFor that, you can [view and download the package from its Anaconda.org page (conda-forge channel)](https://anaconda.org/conda-forge/subgroups) or directly install it by executing:\r\n\r\n```shell\r\nconda install -c conda-forge subgroups\r\n```\r\n\r\n## Testing\r\n\r\nAfter installing the library, a collection of tests can be launched by executing:\r\n\r\n```python\r\nimport subgroups.tests as st\r\nst.run_all_tests()\r\n```\r\n\r\nThese tests verify that the library is correctly installed and that all components, algorithms and features are properly working.\r\n\r\n## Installing from source\r\n\r\nThe source code (latest development) is currently hosted on: https://github.com/antoniolopezmc/subgroups\r\n\r\nTherefore, you need first to clone the repository:\r\n\r\n```shell\r\ngit clone https://github.com/antoniolopezmc/subgroups.git\r\ncd subgroups\r\n```\r\n\r\nAfter that, the library can be installed in *production mode* or in *develop mode*.\r\n\r\n### Production mode\r\n\r\n```shell\r\nmake install_prod\r\n```\r\n\r\nor\r\n\r\n```shell\r\npython -m pip install ./\r\n```\r\n\r\nor\r\n\r\n```shell\r\npip install ./\r\n```\r\n\r\nThis mode installs the library as normal, copying it to the standard Python site-packages directory.\r\n\r\n### Develop mode\r\n\r\n```shell\r\nmake install_dev\r\n```\r\n\r\nor\r\n\r\n```shell\r\npython -m pip install -e ./\r\n```\r\n\r\nor\r\n\r\n```shell\r\npip install -e ./\r\n```\r\n\r\nThis mode installs the library in editable mode, creating a link in the standard Python site-packages directory to the downloaded project directory (the current directory). See the [pip_install documentation](https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-e) for further details.\r\n\r\n## Example of use of the algorithms\r\n\r\nAn example of use of each algorithm implemented in `subgroups` python library can be found in the `examples/algorithms` folder:\r\n\r\n- [SDMap](https://github.com/antoniolopezmc/subgroups/blob/master/examples/algorithms/SDMap.ipynb)\r\n- [SDMap*](https://github.com/antoniolopezmc/subgroups/blob/master/examples/algorithms/SDMapStar.ipynb)\r\n- [VLSD](https://github.com/antoniolopezmc/subgroups/blob/master/examples/algorithms/VLSD.ipynb)\r\n- [BSD-CBSD-CPBSD](https://github.com/antoniolopezmc/subgroups/blob/master/examples/algorithms/BSD-CBSD-CPBSD.ipynb)\r\n- [QFinder](https://github.com/antoniolopezmc/subgroups/blob/master/examples/algorithms/QFinder.ipynb)\r\n- [GMSL](https://github.com/antoniolopezmc/subgroups/blob/master/examples/algorithms/GMSL.ipynb)\r\n- [DSLM](https://github.com/antoniolopezmc/subgroups/blob/master/examples/algorithms/DSLM.ipynb)\r\n\r\n## Documentation\r\n\r\nThe official documentation is hosted on https://www.um.es/subgroups/\r\n\r\nAdditionally, the source code of the project contains a folder called `docs`, which includes the documentation of the library. This documentation can be also manually generated by executing:\r\n\r\n```shell\r\ncd docs\r\nmake build\r\n```\r\n\r\nor\r\n\r\n```shell\r\ncd docs\r\npython clean.py source/project_files build\r\npython -m pip install --upgrade sphinx\r\npython -m pip install --upgrade sphinx-rtd-theme\r\npython -m pip install --upgrade sphinx-autodoc-typehints\r\nsphinx-apidoc -f -T -M -o source/project_files ../src/subgroups\r\nsphinx-build -M html source build\r\n```\r\n\r\nThe generated documentation will be located in the `build` subfolder.\r\n",
"bugtrack_url": null,
"license": "BSD-4-Clause",
"summary": "subgroups is a python library which contains a collection of subgroup discovery algorithms and other data analysis utilities.",
"version": "0.1.8",
"project_urls": {
"Homepage": "https://github.com/antoniolopezmc/subgroups"
},
"split_keywords": [
"python",
" data-science",
" machine-learning",
" data-analysis",
" subgroups",
" subgroup-discovery"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cd8060656188b254ec1fa0d4fb76548db2a444f56e1dbe27fe47a7fb545ce1af",
"md5": "3424063798b1ab9d841026c0c908b91d",
"sha256": "02d367152556dcc595b5f3643c91ef4ddd5d760124d7d50d0151ebd11c98e685"
},
"downloads": -1,
"filename": "subgroups-0.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3424063798b1ab9d841026c0c908b91d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.0",
"size": 254956,
"upload_time": "2024-05-28T10:39:28",
"upload_time_iso_8601": "2024-05-28T10:39:28.394751Z",
"url": "https://files.pythonhosted.org/packages/cd/80/60656188b254ec1fa0d4fb76548db2a444f56e1dbe27fe47a7fb545ce1af/subgroups-0.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "db35e15d59a22f7802cd62d72cbda1a9d4dca1c15cdaccaa87d880005b63ec8d",
"md5": "b4c4697cf7096d21da8b99226b5a829d",
"sha256": "4f4b5345edcaca7c38fb7f5102b6b192f101fcdcdf50c42565c05fb363f3f89c"
},
"downloads": -1,
"filename": "subgroups-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "b4c4697cf7096d21da8b99226b5a829d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.0",
"size": 181046,
"upload_time": "2024-05-28T10:39:30",
"upload_time_iso_8601": "2024-05-28T10:39:30.243560Z",
"url": "https://files.pythonhosted.org/packages/db/35/e15d59a22f7802cd62d72cbda1a9d4dca1c15cdaccaa87d880005b63ec8d/subgroups-0.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-28 10:39:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "antoniolopezmc",
"github_project": "subgroups",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "subgroups"
}
JSON
