k_means_cluster 0.2.1

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 60

k-means-cluster #

A very simple implementation of k-means clustering.

Usage #

A clustering session typically involves:

  • Setting a distance measurement to use.
distanceMeasure = DistanceType.squaredEuclidian; // default
  • Creating a List of Instances. This is generally done by mapping a list of whatever data structures is available.
// For example, data might be a List<String> such
// that each String represents an individual instance.
List<Instance> instances = data.map((datum) {
  List<num> coordinates = ...;
  String id = ...;
  return Instance(coordinates, id: id); 
}).tolist();
  • Creating a List of Clusters. This can be done manually (e.g. create a set of randomly placed clusters). A convenience function initialClusters exists that takes in the list of Instances already created and randomly generates clusters from the instances such that instances more distant to the previous cluster are more likely to seed the next cluster.
List<Cluster> clusters = initialClusters(3, instances, seed: 0);
  • Running the algorithm using the kmeans function. This is a side-effect heavy function that iteratively shifts the clusters towards the mean position of the associated instances and reassigns instances to the nearest cluster.
kmeans(clusters: clusters, instances: instances);
  • Inspecting the instances property of each cluster.
clusters.forEach((cluster) {
  print(cluster);
  cluster.instances.forEach((instance) {
    print("  - $instance");
  });
});

Please see the associated wiki for more details and examples.

Please file feature requests and bugs at the issue tracker.

Changelog #

0.2.1 #

  • Dart 2 ready

0.1.0 #

  • Initial version.
  • Basic knn-clustering.
  • Distance measures: square Euclidian, city block.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  k_means_cluster: ^0.2.1

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter packages get

Alternatively, your editor might support pub get or flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:k_means_cluster/k_means_cluster.dart';
  
Version Uploaded Documentation Archive
0.2.1 Aug 28, 2018 Go to the documentation of k_means_cluster 0.2.1 Download k_means_cluster 0.2.1 archive
0.2.0 Aug 28, 2018 Go to the documentation of k_means_cluster 0.2.0 Download k_means_cluster 0.2.0 archive
0.1.1 Jun 6, 2017 Go to the documentation of k_means_cluster 0.1.1 Download k_means_cluster 0.1.1 archive
0.1.0 Jun 6, 2017 Go to the documentation of k_means_cluster 0.1.0 Download k_means_cluster 0.1.0 archive
0.0.1 Jun 6, 2017 Go to the documentation of k_means_cluster 0.0.1 Download k_means_cluster 0.0.1 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
33
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
66
Overall:
Weighted score of the above. [more]
60
Learn more about scoring.

We analyzed this package on Feb 14, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.1.0
  • pana: 0.12.13

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in primary library package:k_means_cluster/k_means_cluster.dart.

Health suggestions

Fix lib/src/k_means_cluster_base.dart. (-0.50 points)

Analysis of lib/src/k_means_cluster_base.dart reported 1 hint:

line 134 col 23: Use = to separate a named parameter from its default value.

Maintenance issues and suggestions

Homepage URL doesn't exist. (-20 points)

At the time of the analysis the homepage field https://bitbucket.org/ram6ler/knn-cluster/wiki/Home was unreachable.

The package description is too short. (-14 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Maintain an example.

None of the files in the package's example/ directory matches known example patterns.

Common filename patterns include main.dart, example.dart, and k_means_cluster.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0