12 releases (7 breaking)

0.8.0 Feb 21, 2024
0.7.0 Dec 21, 2023
0.6.0 Aug 7, 2023
0.5.1 May 3, 2022
0.1.0 Feb 18, 2020

#38 in Machine learning

Download history 25/week @ 2023-12-02 7/week @ 2023-12-09 4/week @ 2023-12-16 10/week @ 2024-01-20 100/week @ 2024-02-03 175/week @ 2024-02-10 280/week @ 2024-02-17 184/week @ 2024-02-24 82/week @ 2024-03-02 33/week @ 2024-03-09

619 downloads per month
Used in 3 crates

Apache-2.0

57KB
1.5K SLoC

petal-clustering

A collection of clustering algorithms. Currently this crate provides DBSCAN, HDBSCAN and OPTICS.

crates.io Documentation Coverage Status

Examples

The following example shows how to cluster points using DBSCAN.

use ndarray::array;
use petal_clustering::{Dbscan, Fit};

let points = array![[1., 2.], [2., 2.], [2., 2.3], [8., 7.], [8., 8.], [25., 80.]];
let clustering = Dbscan::new(3.0, 2).fit(&points);

assert_eq!(clustering.0.len(), 2);        // two clusters found
assert_eq!(clustering.0[&0], [0, 1, 2]);  // the first three points in Cluster 0
assert_eq!(clustering.0[&1], [3, 4]);     // [8., 7.] and [8., 8.] in Cluster 1
assert_eq!(clustering.1, [5]);            // [25., 80.] doesn't belong to any cluster

License

Copyright 2019-2023 Petabi, Inc.

Licensed under Apache License, Version 2.0 (the "License"); you may not use this crate except in compliance with the License.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See LICENSE for the specific language governing permissions and limitations under the License.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be licensed as above, without any additional terms or conditions.

Dependencies

~4MB
~83K SLoC