Metadata-Version: 2.1
Name: mat-clustering
Version: 0.1rc1
Summary: Clustering Methods for Multiple Aspect Trajectory Data Mining
Home-page: https://github.com/mat-analysis/mat-clustering
Author: Yuri Nassar
Author-email: Yuri Santos <yuri.nassar@gmail.com>
Maintainer-email: Tarlis Tortelli Portela <tarlis@tarlis.com.br>, Yuri Santos <yuri.nassar@gmail.com>
License: GPL Version 3 or superior (see LICENSE file)
Project-URL: Homepage, https://github.com/mat-analysis/mat-clustering
Project-URL: Repository, https://github.com/mat-analysis/mat-clustering
Project-URL: Documentation, https://mat-analysis.github.io/mat-tools/mat-clustering/index.html
Project-URL: Download, https://pypi.org/project/mat-clustering/#files
Project-URL: Bug Tracker, https://github.com/mat-analysis/mat-clustering/issues
Keywords: data-science,machine-learning,data-mining,trajectory,multiple-trajectory,clustering
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Operating System :: OS Independent
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python :: 3.10
Requires-Python: <3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: glob2==0.7
Requires-Dist: numpy
Requires-Dist: pandas==1.3.4
Requires-Dist: mat-data
Requires-Dist: mat-model
Provides-Extra: dev
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-xdist; extra == "dev"
Requires-Dist: wheel; extra == "dev"
Provides-Extra: binder
Requires-Dist: jupyter; extra == "binder"
Provides-Extra: docs
Requires-Dist: jupyter; extra == "docs"
Requires-Dist: numpydoc; extra == "docs"
Provides-Extra: dl

# MAT-clustering: Clustering Methods for Multiple Aspect Trajectory Data Mining \[MAT-Tools Framework\]
---

\[[Publication](#)\] \[[Bibtex](https://github.com/mat-analysis/mat-tools/blob/main/references/mat-tools.bib)\] \[[GitHub](https://github.com/mat-analysis/mat-clustering)\] \[[PyPi](https://pypi.org/project/mat-clustering/)\]

The present application offers a tool, to support the user in the data mining task of multiple aspect trajectories, specifically for clustering its complex data. It integrates into a unique platform the fragmented approaches available for multiple aspects trajectories and in general for multidimensional sequence classification into a unique web-based and python library system. 

Created on Apr, 2024
Copyright (C) 2024, License GPL Version 3 or superior (see LICENSE file)

### Main Modules

- Core Classes:
    1. **TrajectoryClustering** - Base class for trajectory clustering
    2. **HSTrajectoryClustering** - Hyperparameter search model for trajectory clustering
    3. **SimilarityClustering** - Similarity-based clustering for trajectory data

- Similarity-based clustering methods:
    1. **TSAgglomerative** - MAT Hierarchical Agglomerative Clustering
    2. **TSBirch** - MAT BIRCH Clustering
    3. **TSDBSCAN** - MAT DBSCAN Clustering    
    4. **TSKMeans** - MAT K-Means Clustering
    5. **TSKMedoids** - MAT K-Medoids Clustering
    6. **TSpectral** - MAT Spectral Clustering
    
- CoClustering clustering methods: **Under Development**

- Hierarchical clustering methods: **Under Development**

### Installation

Install directly from PyPi repository, or, download from github. (python >= 3.7 required)

```bash
    pip install mat-clustering
```

### Citing

If you use `mat-clustering` please cite the following paper:

 - Portela, T. T.; Machado, V. L.; Renso, C. Unified Approach to Trajectory Data Mining and Multi-Aspect Trajectory Analysis with MAT-Tools Framework. In: SIMPÓSIO BRASILEIRO DE BANCO DE DADOS (SBBD), 39. , 2024, Florianópolis/SC. \[[Bibtex](https://github.com/mat-analysis/mat-tools/blob/main/references/mat-tools.bib)\]

### Collaborate with us

Any contribution is welcome. This is an active project and if you would like to include your algorithm in `matclustering`, feel free to fork the project, open an issue and contact us.

Feel free to contribute in any form, such as scientific publications referencing `matclustering`, teaching material and workshop videos.

### Related packages

This package is part of _MAT-Tools Framework_ for Multiple Aspect Trajectory Data Mining, check the guide project:

- **[mat-tools](https://github.com/mat-analysis/mat-tools)**: Reference guide for MAT-Tools Framework repositories


### Change Log

This is a package under construction, see [CHANGELOG.md](https://github.com/mat-analysis/mat-clustering/blob/main/CHANGELOG.md)
