## ``mkl_random`` -- a NumPy-based Python interface to Intel (R) MKL Random Number Generation functionality
[![Build Status](https://travis-ci.com/IntelPython/mkl_random.svg?branch=master)](https://travis-ci.com/IntelPython/mkl_random)
`mkl_random` has started as Intel (R) Distribution for Python optimizations for NumPy.
Per NumPy's community suggestions, voiced in https://github.com/numpy/numpy/pull/8209, it is being released as a
stand-alone package.
Prebuilt `mkl_random` can be installed into conda environment from Intel's channel on Anaconda cloud:
```
conda install -c intel mkl_random
```
---
To install mkl_random Pypi package please use following command:
```
python -m pip install --i https://pypi.anaconda.org/intel/simple -extra-index-url https://pypi.org/simple mkl_random
```
If command above installs NumPy package from the Pypi, please use following command to install Intel optimized NumPy wheel package from Anaconda Cloud:
```
python -m pip install --i https://pypi.anaconda.org/intel/simple -extra-index-url https://pypi.org/simple mkl_random numpy==<numpy_version>
```
Where `<numpy_version>` should be the latest version from https://anaconda.org/intel/numpy
---
`mkl_random` is not fixed-seed backward compatible drop-in replacement for `numpy.random`, meaning that it implements sampling from the same distributions as `numpy.random`.
For distributions directly supported in Intel (R) Math Kernel Library (MKL), `method` keyword is supported:
```
mkl_random.standard_normal(size=(10**5, 10**3), method='BoxMuller')
```
Additionally, `mkl_random` exposes different basic random number generation algorithms available in MKL. For example to use `SFMT19937` use
```
mkl_random.RandomState(77777, brng='SFMT19937')
```
For generator families, such that `MT2203` and Wichmann-Hill, a particular member of the family can be chosen by specifying ``brng=('WH', 3)``, etc.
The list of supported by `mkl_random.RandomState` constructor `brng` keywords is as follows:
* 'MT19937'
* 'SFMT19937'
* 'WH' or ('WH', id)
* 'MT2203' or ('MT2203', id)
* 'MCG31'
* 'R250'
* 'MRG32K3A'
* 'MCG59'
* 'PHILOX4X32X10'
* 'NONDETERM'
* 'ARS5'
Raw data
{
"_id": null,
"home_page": "http://github.com/IntelPython/mkl_random",
"name": "mkl-random",
"maintainer": "Intel Corp.",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "scripting@intel.com",
"keywords": "MKL, VSL, true randomness, pseudorandomness, Philox, MT-19937, SFMT-19937, MT-2203, ARS-5, R-250, MCG-31",
"author": "Intel Corporation",
"author_email": null,
"download_url": "http://github.com/IntelPython/mkl_random",
"platform": "Windows",
"description": "## ``mkl_random`` -- a NumPy-based Python interface to Intel (R) MKL Random Number Generation functionality\n[![Build Status](https://travis-ci.com/IntelPython/mkl_random.svg?branch=master)](https://travis-ci.com/IntelPython/mkl_random)\n\n`mkl_random` has started as Intel (R) Distribution for Python optimizations for NumPy.\n\nPer NumPy's community suggestions, voiced in https://github.com/numpy/numpy/pull/8209, it is being released as a\nstand-alone package.\n\nPrebuilt `mkl_random` can be installed into conda environment from Intel's channel on Anaconda cloud:\n\n```\n conda install -c intel mkl_random\n```\n\n---\n\nTo install mkl_random Pypi package please use following command:\n\n```\n python -m pip install --i https://pypi.anaconda.org/intel/simple -extra-index-url https://pypi.org/simple mkl_random\n```\n\nIf command above installs NumPy package from the Pypi, please use following command to install Intel optimized NumPy wheel package from Anaconda Cloud:\n\n```\n python -m pip install --i https://pypi.anaconda.org/intel/simple -extra-index-url https://pypi.org/simple mkl_random numpy==<numpy_version>\n```\n\nWhere `<numpy_version>` should be the latest version from https://anaconda.org/intel/numpy\n\n---\n\n`mkl_random` is not fixed-seed backward compatible drop-in replacement for `numpy.random`, meaning that it implements sampling from the same distributions as `numpy.random`.\n\nFor distributions directly supported in Intel (R) Math Kernel Library (MKL), `method` keyword is supported:\n\n```\n mkl_random.standard_normal(size=(10**5, 10**3), method='BoxMuller')\n```\n\nAdditionally, `mkl_random` exposes different basic random number generation algorithms available in MKL. For example to use `SFMT19937` use\n\n```\n mkl_random.RandomState(77777, brng='SFMT19937')\n```\n\nFor generator families, such that `MT2203` and Wichmann-Hill, a particular member of the family can be chosen by specifying ``brng=('WH', 3)``, etc.\n\nThe list of supported by `mkl_random.RandomState` constructor `brng` keywords is as follows:\n\n * 'MT19937'\n * 'SFMT19937'\n * 'WH' or ('WH', id)\n * 'MT2203' or ('MT2203', id)\n * 'MCG31'\n * 'R250'\n * 'MRG32K3A'\n * 'MCG59'\n * 'PHILOX4X32X10'\n * 'NONDETERM'\n * 'ARS5'\n\n\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "NumPy-based Python interface to Intel (R) MKL Random Number Generation functionality",
"version": "1.2.4",
"project_urls": {
"Download": "http://github.com/IntelPython/mkl_random",
"Homepage": "http://github.com/IntelPython/mkl_random"
},
"split_keywords": [
"mkl",
" vsl",
" true randomness",
" pseudorandomness",
" philox",
" mt-19937",
" sfmt-19937",
" mt-2203",
" ars-5",
" r-250",
" mcg-31"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e73fc6d6feb8442356bd42469fff0e1debe57758a385774b5ee6a2af2c2f4b85",
"md5": "f9f2b0083219b5924c23e60bebc25213",
"sha256": "78cada0e7b04511ba3d25f02d435953f8a8491f7dbd240396bc7a3cf42ceb766"
},
"downloads": -1,
"filename": "mkl_random-1.2.4-90-cp310-cp310-manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "f9f2b0083219b5924c23e60bebc25213",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.7",
"size": 4194874,
"upload_time": "2024-03-26T22:33:49",
"upload_time_iso_8601": "2024-03-26T22:33:49.707464Z",
"url": "https://files.pythonhosted.org/packages/e7/3f/c6d6feb8442356bd42469fff0e1debe57758a385774b5ee6a2af2c2f4b85/mkl_random-1.2.4-90-cp310-cp310-manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dc0de9c4e5f857f776fd7c59e1256679d3094a05db39eac2c73d404aefbc3729",
"md5": "0283b2867aa960fb9025468dc8a4c396",
"sha256": "314b4cfa40f5c1901a0672c38a27a93f327088e649919c31d87243eb07577cd8"
},
"downloads": -1,
"filename": "mkl_random-1.2.4-90-cp310-cp310-win_amd64.whl",
"has_sig": false,
"md5_digest": "0283b2867aa960fb9025468dc8a4c396",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.7",
"size": 249196,
"upload_time": "2024-03-26T22:33:53",
"upload_time_iso_8601": "2024-03-26T22:33:53.177020Z",
"url": "https://files.pythonhosted.org/packages/dc/0d/e9c4e5f857f776fd7c59e1256679d3094a05db39eac2c73d404aefbc3729/mkl_random-1.2.4-90-cp310-cp310-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2ced6a5d229d306345c93a12b13d8ab986b4fa1490d75ed61e2a60b5f7806482",
"md5": "ba447a3ff282f141fc0647a9bd3c1293",
"sha256": "55830cb95a41f280bbdd59b9a91527b60a7389fc4dca71c9e75b2bbd34925206"
},
"downloads": -1,
"filename": "mkl_random-1.2.4-90-cp39-cp39-manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "ba447a3ff282f141fc0647a9bd3c1293",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.7",
"size": 4207227,
"upload_time": "2024-03-26T22:33:43",
"upload_time_iso_8601": "2024-03-26T22:33:43.408460Z",
"url": "https://files.pythonhosted.org/packages/2c/ed/6a5d229d306345c93a12b13d8ab986b4fa1490d75ed61e2a60b5f7806482/mkl_random-1.2.4-90-cp39-cp39-manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4f3dd4b073105d880bef92c49b29b6771e9b9063a205f0cb59f468dbbfc53e03",
"md5": "2c82becb5c072f478739d825d3c0b334",
"sha256": "b2007f5d6e9d0bedb52f66602a87cf91841a9e39b1f50f32b9d5495c6ddd0be0"
},
"downloads": -1,
"filename": "mkl_random-1.2.4-90-cp39-cp39-win_amd64.whl",
"has_sig": false,
"md5_digest": "2c82becb5c072f478739d825d3c0b334",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.7",
"size": 261717,
"upload_time": "2024-03-26T22:33:46",
"upload_time_iso_8601": "2024-03-26T22:33:46.071183Z",
"url": "https://files.pythonhosted.org/packages/4f/3d/d4b073105d880bef92c49b29b6771e9b9063a205f0cb59f468dbbfc53e03/mkl_random-1.2.4-90-cp39-cp39-win_amd64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-26 22:33:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "IntelPython",
"github_project": "mkl_random",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"lcname": "mkl-random"
}