Skip to content

Commit 780fde9

Browse files
Merge pull request #21 from IntelPython/upd_wheel_description
Update description for wheel package
2 parents 0794743 + 92be4a8 commit 780fde9

File tree

3 files changed

+25
-3
lines changed

3 files changed

+25
-3
lines changed

README.md

+18
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,24 @@ Prebuilt `mkl_random` can be installed into conda environment from Intel's chann
1212
conda install -c intel mkl_random
1313
```
1414

15+
---
16+
17+
To install mkl_random Pypi package please use following command:
18+
19+
```
20+
python -m pip install --i https://pypi.anaconda.org/intel/simple -extra-index-url https://pypi.org/simple mkl_random
21+
```
22+
23+
If command above installs NumPy package from the Pypi, please use following command to install Intel optimized NumPy wheel package from Anaconda Cloud:
24+
25+
```
26+
python -m pip install --i https://pypi.anaconda.org/intel/simple -extra-index-url https://pypi.org/simple mkl_random numpy==<numpy_version>
27+
```
28+
29+
Where `<numpy_version>` should be the latest version from https://anaconda.org/intel/numpy
30+
31+
---
32+
1533
`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`.
1634

1735
For distributions directly supported in Intel (R) Math Kernel Library (MKL), `method` keyword is supported:

conda-recipe/meta.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{% set version = "1.2.0" %}
1+
{% set version = "1.2.2" %}
22
{% set buildnumber = 0 %}
33

44
### If you change the iccver here, you must also set the path correctly in build.sh / bld.bat!!!

setup.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@
3434
with io.open('mkl_random/_version.py', 'rt', encoding='utf8') as f:
3535
version = re.search(r'__version__ = \'(.*?)\'', f.read()).group(1)
3636

37+
with open("README.md", "r", encoding="utf-8") as file:
38+
long_description = file.read()
39+
3740
VERSION = version
3841

3942
CLASSIFIERS = ""
@@ -67,8 +70,9 @@ def setup_package():
6770
name = 'mkl_random',
6871
maintainer = "Intel Corp.",
6972
maintainer_email = "scripting@intel.com",
70-
description = "",
71-
long_description = """""",
73+
description = "NumPy-based Python interface to Intel (R) MKL Random Number Generation functionality",
74+
long_description = long_description,
75+
long_description_content_type="text/markdown",
7276
url = "http://github.com/IntelPython/mkl_random",
7377
author = "Intel Corporation",
7478
download_url = "http://github.com/IntelPython/mkl_random",

0 commit comments

Comments
 (0)