feat: add `ml/base/kmeans/algorithms` by nakul-krishnakumar · Pull Request #10796 · stdlib-js/stdlib

nakul-krishnakumar · 2026-03-07T06:35:18Z

Resolves None.

Description

What is the purpose of this pull request?

This pull request:

Adds enum ml/cluster/base/kmeans/algorithms.

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

None.

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

Read, understood, and followed the contributing guidelines.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

Yes
No

If you answered "yes" above, how did you use AI assistance?

Code generation (e.g., when writing an implementation or fixing a bug)
Test/benchmark generation
Documentation (including examples)
Research and understanding

Disclosure

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

None.

@stdlib-js/reviewers

stdlib-bot · 2026-03-07T06:38:09Z

Coverage Report

Package	Statements	Branches	Functions	Lines
ml/base/kmeans/algorithms	$\color{green}142/142$ $\color{green}+0.00%$	$\color{green}5/5$ $\color{green}+0.00%$	$\color{green}2/2$ $\color{green}+0.00%$	$\color{green}142/142$ $\color{green}+0.00%$

The above coverage report was generated for the changes in this PR.

--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---

Co-authored-by: Nakul Krishnakumar <nakulkrishnakumar86@gmail.com> Signed-off-by: Nakul Krishnakumar <nakulkrishnakumar86@gmail.com>

--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---

kgryte · 2026-05-06T11:37:09Z

+var contains = require( '@stdlib/array/base/assert/contains' ).factory;
+var algorithms = require( './../lib' );
+
+var isAlternative = contains( algorithms() );


I believe you want isAlgorithm here and below.

Oops, my bad.

kgryte · 2026-05-06T11:39:13Z

+// TypeScript Version: 4.1
+
+/**
+* Returns a list of clustering algorithms.


Suggested change

* Returns a list of clustering algorithms.

* Returns a list of k-means clustering algorithms.

kgryte · 2026-05-06T11:39:36Z

@@ -0,0 +1,22 @@
+
+{{alias}}()
+    Returns a list of kmeans clustering algorithms.


Suggested change

Returns a list of kmeans clustering algorithms.

Returns a list of k-means clustering algorithms.

k-means should be hyphenated wherever it is used in prose.

kgryte · 2026-05-06T11:40:16Z

+// MAIN //
+
+/**
+* Returns an object mapping supported KMeans clustering algorithms to integer values for purposes of C inter-operation.


Suggested change

* Returns an object mapping supported KMeans clustering algorithms to integer values for purposes of C inter-operation.

* Returns an object mapping supported k-means clustering algorithms to integer values for purposes of C inter-operation.

Be consistent with spelling.

kgryte · 2026-05-06T11:40:44Z

+'use strict';
+
+/**
+* Return a list of KMeans clustering algorithms.


Suggested change

* Return a list of KMeans clustering algorithms.

* Return a list of k-means clustering algorithms.

kgryte · 2026-05-06T11:40:53Z

+// MAIN //
+
+/**
+* Returns a list of KMeans clustering algorithms.


Suggested change

* Returns a list of KMeans clustering algorithms.

* Returns a list of k-means clustering algorithms.

kgryte · 2026-05-06T11:41:20Z

+/**
+* Returns a list of KMeans clustering algorithms.
+*
+* @returns {StringArray} list of clustering algorithms


Suggested change

* @returns {StringArray} list of clustering algorithms

* @returns {Array<string>} list of clustering algorithms

We're slowly moving away from using StringArray to indicate Array<string>.

kgryte · 2026-05-06T11:41:30Z

+	t.end();
+});
+
+tape( 'the function returns a list of kmeans clustering algorithms', function test( t ) {


Suggested change

tape( 'the function returns a list of kmeans clustering algorithms', function test( t ) {

tape( 'the function returns a list of k-means clustering algorithms', function test( t ) {

kgryte · 2026-05-06T11:42:44Z

+{
+  "name": "@stdlib/ml/base/cluster/kmeans/algorithms",
+  "version": "0.0.0",
+  "description": "KMeans clustering algorithms.",


Suggested change

"description": "KMeans clustering algorithms.",

"description": "k-means clustering algorithms.",

kgryte · 2026-05-06T11:42:59Z

+
+# Clustering Algorithms
+
+> KMeans clustering algorithms.


Suggested change

> KMeans clustering algorithms.

> k-means clustering algorithms.

kgryte · 2026-05-06T11:43:11Z

+
+#### algorithms()
+
+Returns a list of KMeans clustering algorithms.


Suggested change

Returns a list of KMeans clustering algorithms.

Returns a list of k-means clustering algorithms.

Applies here and everywhere else.

kgryte

Left initial comments.

--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---

…eans/algorithms` --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---

nakul-krishnakumar · 2026-05-07T06:09:34Z

We had agreed on keeping a common namespace for all ML APIs rather than creating sub-namespaces like cluster/*, regression/* etc., and planned to move into the later in the future if required. So I have migrated ml/base/cluster/kmeans/algorithms to ml/base/kmeans/algorithms.
Ref: my gsoc proposal

Signed-off-by: Nakul Krishnakumar <nakulkrishnakumar86@gmail.com>

stdlib-bot added the Needs Review A pull request which needs code review. label Mar 7, 2026

nakul-krishnakumar marked this pull request as draft March 7, 2026 06:35

stdlib-bot removed the Needs Review A pull request which needs code review. label Mar 7, 2026

nakul-krishnakumar changed the title ~~feat: add enum ml/cluster/base/kmeans/algorithms~~ feat: add enum ml/base/cluster/kmeans/algorithms Mar 8, 2026

This was referenced Mar 27, 2026

[RFC]: implement machine learning algorithms in Javascript and C nakul-krishnakumar/stdlib-showcase#1

Open

[RFC]: add batch machine learning algorithms in Javascript and C stdlib-js/google-summer-of-code#203

Closed

nakul-krishnakumar force-pushed the ml-algorithms-enum branch from b192cb0 to 18d467a Compare May 6, 2026 08:00

feat: add ml/cluster/base/kmeans/algorithms

c269779

nakul-krishnakumar force-pushed the ml-algorithms-enum branch from 18d467a to c269779 Compare May 6, 2026 08:01

nakul-krishnakumar commented May 6, 2026

View reviewed changes

Comment thread lib/node_modules/@stdlib/ml/base/cluster/kmeans/algorithms/docs/repl.txt Outdated

nakul-krishnakumar commented May 6, 2026

View reviewed changes

Comment thread ...@stdlib/ml/base/cluster/kmeans/algorithms/include/stdlib/ml/cluster/base/kmeans/algorithms.h Outdated

nakul-krishnakumar added 2 commits May 6, 2026 13:41

chore: update according to code review

7b6ec9e

Co-authored-by: Nakul Krishnakumar <nakulkrishnakumar86@gmail.com> Signed-off-by: Nakul Krishnakumar <nakulkrishnakumar86@gmail.com>

nakul-krishnakumar marked this pull request as ready for review May 6, 2026 08:24

nakul-krishnakumar requested a review from a team May 6, 2026 08:24

stdlib-bot added the Needs Review A pull request which needs code review. label May 6, 2026

kgryte reviewed May 6, 2026

View reviewed changes

kgryte requested changes May 6, 2026

View reviewed changes

nakul-krishnakumar added 2 commits May 6, 2026 22:35

nakul-krishnakumar changed the title ~~feat: add enum ml/base/cluster/kmeans/algorithms~~ feat: add ml/base/kmeans/algorithms May 7, 2026

nakul-krishnakumar requested a review from kgryte May 7, 2026 07:33

stdlib-bot added the Needs Review A pull request which needs code review. label May 7, 2026

nakul-krishnakumar commented May 7, 2026

View reviewed changes

Comment thread lib/node_modules/@stdlib/ml/base/kmeans/algorithms/package.json Outdated

chore: remove cluster from keywords

5f959eb

Signed-off-by: Nakul Krishnakumar <nakulkrishnakumar86@gmail.com>

	* Returns a list of clustering algorithms.
	* Returns a list of k-means clustering algorithms.

		@@ -0,0 +1,22 @@

		{{alias}}()
		Returns a list of kmeans clustering algorithms.

	Returns a list of kmeans clustering algorithms.
	Returns a list of k-means clustering algorithms.

	* Returns an object mapping supported KMeans clustering algorithms to integer values for purposes of C inter-operation.
	* Returns an object mapping supported k-means clustering algorithms to integer values for purposes of C inter-operation.

	* Return a list of KMeans clustering algorithms.
	* Return a list of k-means clustering algorithms.

	* Returns a list of KMeans clustering algorithms.
	* Returns a list of k-means clustering algorithms.

	* @returns {StringArray} list of clustering algorithms
	* @returns {Array<string>} list of clustering algorithms

	tape( 'the function returns a list of kmeans clustering algorithms', function test( t ) {
	tape( 'the function returns a list of k-means clustering algorithms', function test( t ) {

	"description": "KMeans clustering algorithms.",
	"description": "k-means clustering algorithms.",

	> KMeans clustering algorithms.
	> k-means clustering algorithms.


		#### algorithms()

		Returns a list of KMeans clustering algorithms.

Uh oh!

Conversation

nakul-krishnakumar commented Mar 7, 2026

Description

Related Issues

Questions

Other

Checklist

AI Assistance

Disclosure

Uh oh!

stdlib-bot commented Mar 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kgryte May 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kgryte left a comment

Choose a reason for hiding this comment

Uh oh!

nakul-krishnakumar commented May 7, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

stdlib-bot commented Mar 7, 2026 •

edited

Loading

kgryte May 6, 2026 •

edited

Loading