Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

[DOC] Refine documentation of runtime feature detection #14238

Merged
merged 5 commits into from
Mar 5, 2019
Merged

[DOC] Refine documentation of runtime feature detection #14238

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f9dc7f4
minor: Refine documentation
larroy Feb 19, 2019
dcf5811
Update python/mxnet/runtime.py
aaronmarkham Feb 25, 2019
512db19
Update python/mxnet/runtime.py
aaronmarkham Feb 25, 2019
a26aee5
Address CR comment
Feb 26, 2019
bce98bb
retrigger CI
Feb 27, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 59 additions & 18 deletions docs/api/python/libinfo/libinfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,33 +28,74 @@ The libinfo functionality allows to check for compile-time features supported by
### Example usage

```
In [1]: import mxnet as mx
In []: import mxnet as mx
...: import mxnet.runtime
...: fs = mx.runtime.Features()

In [2]: fs
Out[2]: [✖ CUDA, ✖ CUDNN, ✖ NCCL, ✖ CUDA_RTC, ✖ TENSORRT, ✔ CPU_SSE, ✔ CPU_SSE2, ✔ CPU_SSE3, ✔ CPU_SSE4_1, ✔ CPU_SSE4_2, ✖ CPU_SSE4A, ✔ CPU_AVX, ✖ CPU_AVX2, ✖ OPENMP, ✖ SSE, ✔ F16C, ✖ JEMALLOC, ✔ BLAS_OPEN, ✖ BLAS_ATLAS, ✖ BLAS_MKL, ✖ BLAS_APPLE, ✔ LAPACK, ✖ MKLDNN, ✔ OPENCV, ✖ CAFFE, ✖ PROFILER, ✖ DIST_KVSTORE, ✖ CXX14, ✔ SIGNAL_HANDLER, ✔ DEBUG]

In [3]: fs['CUDA'].enabled
Out[3]: False

In [4]: fs.is_enabled('CPU_SSE')
Out[4]: True

In [5]: fs.is_enabled('CUDA')
Out[5]: False

In [6]:
In []: fs
Out[]: [✖ CUDA, ✖ CUDNN, ✖ NCCL, ✖ CUDA_RTC, ✖ TENSORRT, ✔ CPU_SSE, ✔ CPU_SSE2, ✔ CPU_SSE3, ✔ CPU_SSE4_1, ✔ CPU_SSE4_2, ✖ CPU_SSE4A, ✔ CPU_AVX, ✖ CPU_AVX2, ✖ OPENMP, ✖ SSE, ✔ F16C, ✖ JEMALLOC, ✔ BLAS_OPEN, ✖ BLAS_ATLAS, ✖ BLAS_MKL, ✖ BLAS_APPLE, ✔ LAPACK, ✖ MKLDNN, ✔ OPENCV, ✖ CAFFE, ✖ PROFILER, ✖ DIST_KVSTORE, ✖ CXX14, ✔ SIGNAL_HANDLER, ✔ DEBUG]

In []: fs.keys()
Out[]: odict_keys(['CUDA', 'CUDNN', 'NCCL', 'CUDA_RTC', 'TENSORRT', 'CPU_SSE', 'CPU_SSE2', 'CPU_SSE3', 'CPU_SSE4_1', 'CPU_SSE4_2', 'CPU_SSE4A', 'CPU_AVX', 'CPU_AVX2', 'OPENMP', 'SSE', 'F16C', 'JEMALLOC', 'BLAS_OPEN', 'BLAS_ATLAS', 'BLAS_MKL', 'BLAS_APPLE', 'LAPACK', 'MKLDNN', 'OPENCV', 'CAFFE', 'PROFILER', 'DIST_KVSTORE', 'CXX14', 'SIGNAL_HANDLER', 'DEBUG'])

In []: type(fs['CUDA'])
Out[]: mxnet.runtime.Feature

In []: fs['CUDA'].enabled
Out[]: False

In []: fs.is_enabled('CPU_SSE')
Out[]: True

In []: fs.is_enabled('CUDA')
Out[]: False

In []: features = mx.runtime.feature_list()

In []: features
Out[]:
[✖ CUDA,
✖ CUDNN,
✖ NCCL,
✖ CUDA_RTC,
✖ TENSORRT,
✔ CPU_SSE,
✔ CPU_SSE2,
✔ CPU_SSE3,
✔ CPU_SSE4_1,
✔ CPU_SSE4_2,
✖ CPU_SSE4A,
✔ CPU_AVX,
✖ CPU_AVX2,
✖ OPENMP,
✖ SSE,
✔ F16C,
✖ JEMALLOC,
✔ BLAS_OPEN,
✖ BLAS_ATLAS,
✖ BLAS_MKL,
✖ BLAS_APPLE,
✔ LAPACK,
✖ MKLDNN,
✔ OPENCV,
✖ CAFFE,
✖ PROFILER,
✖ DIST_KVSTORE,
✖ CXX14,
✔ SIGNAL_HANDLER,
✔ DEBUG]

In []: type(features)
Out[]: list

In []: type(features[0])
Out[]: mxnet.runtime.Feature
```


```eval_rst
.. autosummary::
:nosignatures:

Features
Feature
feature_list
```

## API Reference
Expand Down
23 changes: 18 additions & 5 deletions python/mxnet/runtime.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,27 @@

class Feature(ctypes.Structure):
"""
Compile time feature description
Compile time feature description, member fields: `name` and `enabled`.
"""
_fields_ = [
("_name", ctypes.c_char_p),
("enabled", ctypes.c_bool)
("_enabled", ctypes.c_bool)
]

@property
def name(self):
"""
Feature name.
"""
return self._name.decode()

@property
def enabled(self):
"""
True if MXNet was compiled with the given compile-time feature.
"""
return self._enabled

def __repr__(self):
if self.enabled:
return "✔ {}".format(self.name)
Expand All @@ -50,7 +60,8 @@ def feature_list():

Returns
-------
:return: list of class LibFeature indicating which features are available and enabled
list
larroy marked this conversation as resolved.
Show resolved Hide resolved
List of :class:`.Feature` objects
"""
lib_features_c_array = ctypes.POINTER(Feature)()
lib_features_size = ctypes.c_size_t()
Expand All @@ -74,11 +85,13 @@ def is_enabled(self, feature_name):

Parameters
----------
:param x: str The name of a valid feature as string for example 'CUDA'
feature_name: str
The name of a valid feature as string for example 'CUDA'

Returns
-------
:return: bool True if it's enabled, False if it's disabled, RuntimeError if the feature is not known
Boolean
True if it's enabled, False if it's disabled, RuntimeError if the feature is not known
"""
feature_name = feature_name.upper()
if feature_name not in self:
Expand Down