Class: UMAP

new UMAP(X, parameters) → {UMAP}

Parameters:

Name Type Attributes Default Description

X

Matrix

the high-dimensional data.

parameters

object

Object containing parameterization of the DR method.

Properties

Name	Type	Attributes	Default	Description
`n_neighbors`	number	<optional>	15	size of the local neighborhood.
`local_connectivity`	number	<optional>	1	number of nearest neighbors connected in the local neighborhood.
`min_dist`	number	<optional>	1	controls how tightly points get packed together.
`d`	number	<optional>	2	the dimensionality of the projection.
`metric`	function	<optional>	euclidean	the metric which defines the distance between two points in the high-dimensional space.
`_spread`	number	<optional>	1	The effective scale of embedded points. (In combination with `parameters.min_dist`)
`_set_op_mix_ratio`	number	<optional>	1	Interpolate between union and intersection.
`_repulsion_strength`	number	<optional>	1	Weighting applied to negative samples.
`_negative_sample_rate`	number	<optional>	5	The number of negative samples per positive sample.
`_n_epochs`	number	<optional>	350	The number of training epochs.

parameter._initial_alpha

number

The initial learning rate for the optimization.

parameters.seed

number

1212

the seed for the random number generator.

Source: dimred/UMAP.js, line 16

Returns:

Type:: UMAP

Extends

Members

projection

Overrides: DR#projection
Source: dimred/DR.js, line 112

Methods

check_init() → {DR}

If the respective DR method has an init function, call it before transform.

Overrides: DR#check_init
Source: dimred/DR.js, line 101

Returns:

Type:: DR

(generator) generator(iterationsopt) → {Matrix|Array.<Array.<number>>}

Parameters:

Name	Type	Attributes	Default	Description
`iterations`	number	<optional>	350	number of iterations.

Overrides: DR#generator
Source: dimred/UMAP.js, line 330

Returns:

Type:: Matrix | Array.<Array.<number>>

init() → {UMAP}

Computes all necessary

Source: dimred/UMAP.js, line 286

Returns:

Type:: UMAP

parameter(nameopt, valueopt) → {DR|any|object}

Set and get parameters

Parameters:

Name	Type	Attributes	Default	Description
`name`	string	<optional>	null	Name of the parameter. If not given then returns all parameters as an Object.
`value`	any	<optional>	null	Value of the parameter to set. If `name` is set and `value` is not given, returns the value of the respective parameter.

Overrides: DR#parameter
Source: dimred/DR.js, line 56

Returns:

On setting a parameter, this function returns the DR object. If name is set and value == null then return actual parameter value. If name is not given, then returns all parameters as an Object.

Type:: DR | any | object

Example

'''
const DR = new druid.TSNE(X, {d: 3}); // creates a new DR object, with parameter for <code>d</code> = 3.
DR.parameter("d"); // returns 3,
DR.parameter("d", 2); // sets parameter <code>d</code> to 2 and returns <code>DR</code>.
'''

transform(iterationsopt) → {Matrix|Array.<Array.<number>>}

Parameters:

Name	Type	Attributes	Default	Description
`iterations`	number	<optional>	350	number of iterations.

Overrides: DR#transform
Source: dimred/UMAP.js, line 313

Returns:

Type:: Matrix | Array.<Array.<number>>

(async) transform_async(…args) → {Promise.<(Matrix|Array.<Array.<number>>)>}

Computes the projection.

Parameters:

Name	Type	Attributes	Description
`args`	unknown	<repeatable>	Arguments the transform method of the respective DR method takes.

Overrides: DR#transform_async
Source: dimred/DR.js, line 126

Returns:

the dimensionality reduced dataset.

Type:: Promise.<(Matrix|Array.<Array.<number>>)>