Skip to content
This repository was archived by the owner on Feb 2, 2024. It is now read-only.

Commit 3d4771e

Browse files
author
Ivan Butygin
authored
Update compilation docs (#759)
1 parent 31b5e4f commit 3d4771e

File tree

2 files changed

+22
-7
lines changed

2 files changed

+22
-7
lines changed

docs/source/getting_started.rst

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,27 @@ The prediction based on gradient boosting regression module is made using scikit
7373
What If I Get A Compilation Error
7474
#################################
7575

76-
.. todo::
77-
Need to give basic information that hpat and numba do not support full set of Pandas and Numpy APIs, provide the link to the API Reference section for Intel® SDC, relevant reference to Numba documentation.
78-
79-
Also give very short introduction to what kind of code Numba/Intel® SDC can compile and what cannot, i.e. type stability etc. Provide the links to relevant sections in Intel® SDC and Numba documentations focusing on compilation issues/limitations
80-
76+
Not all Python code can be compiled with Intel® SDC. Not all `Pandas*`_ and `Numpy*`_ APIs are currently supported and not all valid python code can be compiled using underlying Numba compiler.
77+
78+
To be successfully compiled code must use only supported subset of `Pandas*`_ API and use only subset `Python*`_ supported by `Numba*`_ (e.g. be type-stable)
79+
80+
Example of currently unsupported code:
81+
82+
.. code-block::
83+
:emphasize-lines: 2, 4
84+
85+
if flag:
86+
a = 1.0
87+
else:
88+
a = np.ones(10)
89+
return a # Type of a cannot be inferred
90+
91+
:ref:`SDC API reference<apireference>`
92+
93+
:ref:`More info on SDC compilation process and supported Python features<compilation>`
94+
95+
`Numba documentation <https://numba.pydata.org/numba-doc/latest/user/troubleshoot.html>`_
96+
8197
Measuring Performance
8298
#####################
8399

docs/source/workflow.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,4 @@
44
Step by step on typical data analysis workflow
55
==============================================
66

7-
.. todo::
8-
Discuss high-level issues related to typical data analytics workflow, starting from I/O issues to dataframe processing to machine learning. Discuss each of these aspects on some examples.
7+
Coming soon...

0 commit comments

Comments
 (0)