semvec/pypi-packages huggingface dataset:
mean-shift-cluster-PL 0.0.3
A mean shift clustering tool which accepts both linear and circular-linear data
Requires Python: >=3.8

# Mean-shift-cluster

A tool, mean-shift-cluster is developed, which accepts both circular-linear data and linear data.
Mean-shift-cluster supports three kernels: `flat kernel`, `Gaussian kernel` and `truncated 
Gaussian kernel`.


## Usage
Mean-shift-cluster provides three APIs:
- `fit`: Fit input dataset using mean shift algorithm. Cluster centers and labels
for each sample can be accessed.
- `get_cluster_info`: Provide basic information of each cluster(mode), using input dataset.
- `predict`: Predict the cluster results of any dataset, using the fitted mean-shift-cluster instance.

The inputs are:
- `kernel`: Type is string. Options are: flat, gaussian, truncated_gaussian
- `kernel_parameters`: type is List[float].  
  - For flat kernel: [bandwidth]
  - For Gaussian kernel: [beta]
  - For truncated Gaussian kernel: [bandwidth, beta]
- `data_type`: Type is string. Options are: circular-linear, linear

To run example.py from this directory:
```bash
cd mean-shift
poetry run python example.py
```

A simple usage example is in [example.py](https://github.com/test-bai-cpu/mean-shifter/blob/master/example.py). 
And more details are in the [report](https://github.com/test-bai-cpu/mean-shifter/blob/master/mean-shift-report.pdf).

The script used when writing the report is [reporter.py](https://github.com/test-bai-cpu/mean-shifter/blob/master/reporter.py).