Metadata-Version: 2.1
Name: videoclusters
Version: 0.0.4
Summary: Python library to perform clustering computations on GPU.
Home-page: https://github.com/medoedka/videoclusters
Author: Andrew Vas
Project-URL: Bug Tracker, https://github.com/medoedka/videoclusters/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# videoclusters

Python library to perform clustering computations on GPU.

## Installation

Use the package manager [pip](https://pip.pypa.io/en/stable/) to install videoclusters.

```bash
pip install videoclusters
```

## Usage example

```python
from videoclusters.centroid_based.KMeans import KMeans

# initialization of the cluster
kmeans_cluster = KMeans(num_clusters=2)

# initialization of uneven distributed data
data = torch.randint(low=1,
                     high=10,
                     size=(100, 2),
                     dtype=torch.float32).to('cuda')

data[50:] = torch.randint(low=20,
                          high=30,
                          size=(50, 2),
                          dtype=torch.float32).to('cuda')

# starting computation
result = kmeans_cluster.fit_predict(data)
```

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License
[MIT](https://choosealicense.com/licenses/mit/)
