Add PRank (#734)

Author: ishii-norimi

README.md

@@ -122,7 +122,7 @@ for (let i = 0; i < n; i++) {
 | task | model |
 | ---- | ----- |
 | clustering | (Soft / Kernel / Genetic / Weighted) k-means, k-means++, k-medois, k-medians, x-means, G-means, LBG, ISODATA, Fuzzy c-means, Possibilistic c-means, Agglomerative (complete linkage, single linkage, group average, Ward's, centroid, weighted average, median), DIANA, Monothetic, Mutual kNN, Mean shift, DBSCAN, OPTICS, HDBSCAN, DENCLUE, DBCLASD, CLUES, PAM, CLARA, CLARANS, BIRCH, CURE, ROCK, C2P, PLSA, Latent dirichlet allocation, GMM, VBGMM, Affinity propagation, Spectral clustering, Mountain, (Growing) SOM, GTM, (Growing) Neural gas, Growing cell structures, LVQ, ART, SVC, CAST, CHAMELEON, COLL, CLIQUE, PROCLUS, ORCLUS, FINDIT, NMF, Autoencoder |
-| classification | (Fisher's) Linear discriminant, Quadratic discriminant, Mixture discriminant, Least squares, (Multiclass / Kernel) Ridge, (Complement / Negation / Universal-set / Selective) Naive Bayes (gaussian), AODE, (Fuzzy / Weighted) k-nearest neighbor, Radius neighbor, Nearest centroid, ENN, ENaN, NNBCA, ADAMENN, DANN, IKNN, Decision tree, Random forest, Extra trees, GBDT, XGBoost, ALMA, (Aggressive) ROMMA, (Bounded) Online gradient descent, (Budgeted online) Passive aggressive, RLS, (Selective-sampling) Second order perceptron, AROW, NAROW, Confidence weighted, CELLIP, IELLIP, Normal herd, Stoptron, (Kernelized) Pegasos, MIRA, Forgetron, Projectron, Projectron++, Banditron, Ballseptron, (Multiclass) BSGD, ILK, SILK, (Multinomial) Logistic regression, (Multinomial) Probit, Ordered logistic, Ordered probit, SVM, Gaussian process, HMM, CRF, Bayesian Network, LVQ, (Average / Multiclass / Voted / Kernelized / Selective-sampling / Margin / Shifting / Budget / Tighter / Tightest) Perceptron, PAUM, RBP, ADALINE, MADALINE, MLP, LMNN |
+| classification | (Fisher's) Linear discriminant, Quadratic discriminant, Mixture discriminant, Least squares, (Multiclass / Kernel) Ridge, (Complement / Negation / Universal-set / Selective) Naive Bayes (gaussian), AODE, (Fuzzy / Weighted) k-nearest neighbor, Radius neighbor, Nearest centroid, ENN, ENaN, NNBCA, ADAMENN, DANN, IKNN, Decision tree, Random forest, Extra trees, GBDT, XGBoost, ALMA, (Aggressive) ROMMA, (Bounded) Online gradient descent, (Budgeted online) Passive aggressive, RLS, (Selective-sampling) Second order perceptron, AROW, NAROW, Confidence weighted, CELLIP, IELLIP, Normal herd, Stoptron, (Kernelized) Pegasos, MIRA, Forgetron, Projectron, Projectron++, Banditron, Ballseptron, (Multiclass) BSGD, ILK, SILK, (Multinomial) Logistic regression, (Multinomial) Probit, Ordered logistic, Ordered probit, PRank, SVM, Gaussian process, HMM, CRF, Bayesian Network, LVQ, (Average / Multiclass / Voted / Kernelized / Selective-sampling / Margin / Shifting / Budget / Tighter / Tightest) Perceptron, PAUM, RBP, ADALINE, MADALINE, MLP, LMNN |
 | semi-supervised classification | k-nearest neighbor, Radius neighbor, Label propagation, Label spreading, k-means, GMM, S3VM, Ladder network |
 | regression | Least squares, Ridge, Lasso, Elastic net, RLS, Bayesian linear, Poisson, Least absolute deviations, Huber, Tukey, Least trimmed squares, Least median squares, Lp norm linear, SMA, Deming, Segmented, LOWESS, LOESS, spline, Naive Bayes, Gaussian process, Principal components, Partial least squares, Projection pursuit, Quantile regression, k-nearest neighbor, Radius neighbor, IDW, Nadaraya Watson, Priestley Chao, Gasser Muller, RBF Network, RVM, Decision tree, Random forest, Extra trees, GBDT, XGBoost, SVR, MLP, GMR, Isotonic, Ramer Douglas Peucker, Theil-Sen, Passing-Bablok, Repeated median |
 | interpolation | Nearest neighbor, IDW, (Spherical) Linear, Brahmagupta, Logarithmic, Cosine, (Inverse) Smoothstep, Cubic, (Centripetal) Catmull-Rom, Hermit, Polynomial, Lagrange, Trigonometric, Spline, RBF Network, Akima, Natural neighbor, Delaunay |

js/model_selector.js

@@ -210,6 +210,7 @@ const AIMethods = [
 			Ranking: [
 				{ value: 'ordered_logistic', title: 'Ordered logistic regression' },
 				{ value: 'ordered_probit', title: 'Ordered probit regression' },
+				{ value: 'prank', title: 'PRank' },
 			],
 			'': [
 				{ value: 'least_square', title: 'Least squares' },

js/view/prank.js

@@ -0,0 +1,37 @@
+import PRank from '../../lib/model/prank.js'
+import Controller from '../controller.js'
+
+export default function (platform) {
+	platform.setting.ml.usage =
+		'Click and add data point. Next, click "Initialize". Finally, click "Fit" button repeatedly.'
+	platform.setting.ml.reference = {
+		author: 'K. Crammer, Y. Singer',
+		title: 'Pranking with Ranking ',
+		year: 2001,
+	}
+	const controller = new Controller(platform)
+
+	let model = null
+	const fitModel = () => {
+		if (!model) {
+			return
+		}
+
+		model.fit(
+			platform.trainInput,
+			platform.trainOutput.map(v => v[0])
+		)
+		const pred = model.predict(platform.testInput(4))
+		platform.testResult(pred)
+	}
+
+	const rate = controller.input.number({ label: ' Learning rate ', value: 0.1, min: 0, max: 100, step: 0.1 })
+	controller
+		.stepLoopButtons()
+		.init(() => {
+			model = new PRank(rate.value)
+			platform.init()
+		})
+		.step(fitModel)
+		.epoch()
+}

lib/model/prank.js

@@ -0,0 +1,80 @@
+/**
+ * Perceptron ranking
+ */
+export default class PRank {
+	// Pranking with Ranking
+	// https://proceedings.neurips.cc/paper_files/paper/2001/file/5531a5834816222280f20d1ef9e95f69-Paper.pdf
+	/**
+	 * @param {number} [rate=0.1] Learning rate
+	 */
+	constructor(rate = 0.1) {
+		this._w = null
+		this._a = rate
+
+		this._b = [0, Infinity]
+		this._min = 1
+	}
+
+	/**
+	 * Fit model.
+	 *
+	 * @param {Array<Array<number>>} x Training data
+	 * @param {Array<number>} y Target values
+	 */
+	fit(x, y) {
+		if (!this._w) {
+			this._w = Array(x[0].length).fill(0)
+		}
+
+		for (let k = 0; k < x.length; k++) {
+			if (y[k] < this._min) {
+				this._b.splice(0, 0, ...Array(this._min - y[k]).fill(this._b[0]))
+				this._min = y[k]
+			} else if (y[k] >= this._min + this._b.length) {
+				this._b.splice(
+					this._b.length - 1,
+					0,
+					...Array(this._min + this._b.length - y[k] + 1).fill(this._b[this._b.length - 2])
+				)
+			}
+
+			const p = this._w.reduce((s, v, i) => s + v * x[k][i], 0)
+			let r = 0
+			for (; r < this._b.length; r++) {
+				if (p - this._b[r] < 0) break
+			}
+			const yh = r + this._min
+			if (y[k] === yh) continue
+			let t = 0
+			for (let i = 0; i < this._b.length - 1; i++) {
+				const yt = y[k] <= i + this._min ? -1 : 1
+				if ((p - this._b[i]) * yt <= 0) {
+					t += yt
+					this._b[i] -= this._a * yt
+				}
+			}
+			for (let m = 0; m < this._w.length; m++) {
+				this._w[m] += this._a * t * x[k][m]
+			}
+		}
+	}
+
+	/**
+	 * Returns predicted values.
+	 *
+	 * @param {Array<Array<number>>} x Sample data
+	 * @returns {Array<number>} Predicted values
+	 */
+	predict(x) {
+		const p = []
+		for (let k = 0; k < x.length; k++) {
+			const v = this._w.reduce((s, v, i) => s + v * x[k][i], 0)
+			let r = 0
+			for (; r < this._b.length; r++) {
+				if (v - this._b[r] < 0) break
+			}
+			p[k] = r + this._min
+		}
+		return p
+	}
+}

tests/gui/view/prank.test.js

@@ -0,0 +1,47 @@
+import { getPage } from '../helper/browser'
+
+describe('classification', () => {
+	/** @type {Awaited<ReturnType<getPage>>} */
+	let page
+	beforeEach(async () => {
+		page = await getPage()
+	})
+
+	afterEach(async () => {
+		await page?.close()
+	})
+
+	test('initialize', async () => {
+		const taskSelectBox = await page.waitForSelector('#ml_selector dl:first-child dd:nth-child(5) select')
+		await taskSelectBox.selectOption('CF')
+		const modelSelectBox = await page.waitForSelector('#ml_selector .model_selection #mlDisp')
+		await modelSelectBox.selectOption('prank')
+		const methodMenu = await page.waitForSelector('#ml_selector #method_menu')
+		const buttons = await methodMenu.waitForSelector('.buttons')
+
+		const rate = await buttons.waitForSelector('input:nth-of-type(1)')
+		await expect((await rate.getProperty('value')).jsonValue()).resolves.toBe('0.1')
+	})
+
+	test('learn', async () => {
+		const taskSelectBox = await page.waitForSelector('#ml_selector dl:first-child dd:nth-child(5) select')
+		await taskSelectBox.selectOption('CF')
+		const modelSelectBox = await page.waitForSelector('#ml_selector .model_selection #mlDisp')
+		await modelSelectBox.selectOption('prank')
+		const methodMenu = await page.waitForSelector('#ml_selector #method_menu')
+		const buttons = await methodMenu.waitForSelector('.buttons')
+
+		const epoch = await buttons.waitForSelector('[name=epoch]')
+		await expect(epoch.evaluate(el => el.textContent)).resolves.toBe('0')
+		const methodFooter = await page.waitForSelector('#method_footer', { state: 'attached' })
+		await expect(methodFooter.evaluate(el => el.textContent)).resolves.toBe('')
+
+		const initButton = await buttons.waitForSelector('input[value=Initialize]')
+		await initButton.evaluate(el => el.click())
+		const stepButton = await buttons.waitForSelector('input[value=Step]:enabled')
+		await stepButton.evaluate(el => el.click())
+
+		await expect(epoch.evaluate(el => el.textContent)).resolves.toBe('1')
+		await expect(methodFooter.evaluate(el => el.textContent)).resolves.toMatch(/^Accuracy:[0-9.]+$/)
+	})
+})

tests/lib/model/prank.test.js

@@ -0,0 +1,27 @@
+import { jest } from '@jest/globals'
+jest.retryTimes(10)
+
+import Matrix from '../../../lib/util/matrix.js'
+import PRank from '../../../lib/model/prank.js'
+
+import { rmse } from '../../../lib/evaluate/regression.js'
+
+describe('ordinal', () => {
+	test('fit', () => {
+		const model = new PRank()
+		const x = Matrix.concat(
+			Matrix.concat(Matrix.randn(50, 2, -5, 0.2), Matrix.randn(50, 2, 0, 0.2)),
+			Matrix.concat(Matrix.randn(50, 2, 5, 0.2), Matrix.randn(50, 2, 10, 0.2))
+		).toArray()
+		const t = []
+		for (let i = 0; i < x.length; i++) {
+			t[i] = Math.floor(i / 50)
+		}
+		for (let i = 0; i < 100; i++) {
+			model.fit(x, t)
+		}
+		const y = model.predict(x)
+		const err = rmse(y, t)
+		expect(err).toBeLessThan(0.5)
+	})
+})