# mutual-information-dimension

> Mutual Information Dimension (MID) method for measuring statistical dependence between two random variables

Latest version **0.0.2** (published 2020-05-22) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install mutual-information-dimension
pnpm add mutual-information-dimension
yarn add mutual-information-dimension
bun add mutual-information-dimension
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2020-05-22 |
| First published | 2020-05-22 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 51.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Anton Zemlyansky |
| Maintainers | zemlyansky |
| Keywords | statistics, mi, mutual-information, correlation |

## Links

- npm: https://www.npmjs.com/package/mutual-information-dimension
- Repository: https://github.com/zemlyansky/mutual-information-dimension
- Homepage: https://github.com/zemlyansky/mutual-information-dimension#readme
- Issues: https://github.com/zemlyansky/mutual-information-dimension/issues
- npm.io page: https://npm.io/package/mutual-information-dimension

## Alternatives

- [async-exit-hook](https://npm.io/package/async-exit-hook.md) — 3.7M weekly downloads
- [evnty](https://npm.io/package/evnty.md) — 7.2K weekly downloads
- [eleventy-plugin-asciidoc](https://npm.io/package/eleventy-plugin-asciidoc.md) — 3.5K weekly downloads
- [@jswork/next-get2get](https://npm.io/package/@jswork/next-get2get.md) — 945 weekly downloads
- [@dashersw/axon](https://npm.io/package/@dashersw/axon.md) — 934 weekly downloads

## Recent versions

- 0.0.2 (latest) — 2020-05-22
- 0.0.1 — 2020-05-22

## README

mutual-information-dimension
==================================

Mutual Information Dimension (MID) for measuring statistical dependence between two random variables.
WebAssembly port of the native [MID](https://github.com/BorgwardtLab/MID) package


Summary
-------

An estimation algorithm for MID (Mutual Information Dimension), which measures statistical dependence between two random variables.
This algorithm has the following advantages:

* **Nonlinear dependences** (and also linear dependences) can be measured,
* **Scalable**; the average-case time complexity is O(nlogn), where *n* is the number of data points, and
* **Parameter-free**

Please see the following article for detailed information and refer it in your published research:

* Sugiyama, M., Borgwardt, K. M.: **Measuring Statistical Dependence via the Mutual Information Dimension**,
	*Proceedings of the 23rd International Joint Conference on Artificial Intelligence (IJCAI 2013)*, to appear.


Installation
------------
```
npm install mutual-information-dimension -S
```

Usage
-----

```javascript
const mid = require('mutual-information-dimension')
```

To calculate MID between two variables `x`, `y`, type:

```javascript
const m = mid(x, y)
```
	
Information
-----------

* Author of the native MID package: Mahito Sugiyama
* Affiliation: Machine Learning & Computational Biology Research Group, MPIs Tübingen, Germany
* Mail: mahito.sugiyama@tuebingen.mpg.de

* Author of the WebAssembly port: Anton Zemlyansky
* Mail: anton.zemlyansky@gmail.com

---
_Source: https://npm.io/package/mutual-information-dimension · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._