https://github.com/laschuet/clusteringprototypescriticisms.jl
A Julia package for computing clustering prototypes and criticisms
https://github.com/laschuet/clusteringprototypescriticisms.jl
julia
Last synced: about 1 year ago
JSON representation
A Julia package for computing clustering prototypes and criticisms
- Host: GitHub
- URL: https://github.com/laschuet/clusteringprototypescriticisms.jl
- Owner: laschuet
- License: mit
- Created: 2022-02-16T09:21:36.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-07-19T06:49:04.000Z (almost 4 years ago)
- Last Synced: 2025-02-13T06:42:51.683Z (over 1 year ago)
- Topics: julia
- Language: Julia
- Homepage:
- Size: 760 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ClusteringPrototypesCriticisms.jl
[action-img]: https://github.com/laschuet/ClusteringPrototypesCriticisms.jl/actions/workflows/CI.yml/badge.svg?branch=main
[action-url]: https://github.com/laschuet/ClusteringPrototypesCriticisms.jl/actions/workflows/CI.yml?query=branch%3Amain
[action-ci-url]: https://github.com/laschuet/ClusteringPrototypesCriticisms.jl/actions/workflows/CI.yml
[clustering.jl-url]: https://github.com/JuliaStats/Clustering.jl
[codecov-img]: https://codecov.io/gh/laschuet/ClusteringPrototypesCriticisms.jl/branch/main/graph/badge.svg
[codecov-url]: https://codecov.io/gh/laschuet/ClusteringPrototypesCriticisms.jl
[julia-install-url]: https://julialang.org/downloads
[julia-repl-url]: https://docs.julialang.org/en/v1/stdlib/REPL
[mmdcritic-url]: https://dl.acm.org/doi/10.5555/3157096.3157352
[![][action-img]][action-url]
[![][codecov-img]][codecov-url]
A Julia package for computing clustering prototypes and criticisms.
In particular, we currently support the selection of prototypes and criticisms
with the following methods:
| | Prototypes | Criticisms |
|-----------------------------|-----------:|-----------:|
| [MMD-critic][mmdcritic-url] | ✓ | ✓ |
| k-medoids | ✓ | ✓ |
| k-means | ✓ | ✓ |
| fuzzy c-means | ✓ | ✓ |
| affinity propagation | ✓ | ✓ |
In order to compute prototypes and criticisms for clusterings, we provide two approaches:
1. Directly use a clustering result computed with the
[Clustering.jl][clustering.jl-url] package.
2. Provide the raw data set, the clustering assignments of the data instances,
and the kind of method to be used for computing the prototypes and criticisms.
## Installation
We assume that you have a working [installation of Julia][julia-install-url].
This package is tested on macOS and Ubuntu (x64 platform, Julia 1.7 and nightly)
by [CI][action-ci-url] processes.
Open a [Julia REPL][julia-repl-url] and install the package:
```julia
julia>]
pkg>add https://github.com/laschuet/ClusteringPrototypesCriticisms.jl
```
## Getting started
Open a [Julia REPL][julia-repl-url] and start using the package:
```julia
julia>using ClusteringPrototypesCriticisms
```
Then you can easily read the API documentation:
```julia
julia>?
help?>prototypes
help?>criticisms
help?>sqmmd
help?>witness
```
Alternatively, we invite you to take a quick look at the [source code](src).
## Examples
We also provide some usage [examples](examples).