Skip to content

Commit 793064e

Browse files
sdpythonsdpython
committed
documentation
1 parent 0edee0f commit 793064e

13 files changed

+225
-196
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ dist/*
88
build/*
99
*egg-info/*
1010
_doc/auto_examples/*
11+
_doc/examples/plot_*.png

‎_doc/api/index.rst

+5-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@ API
66
.. toctree::
77
:maxdepth: 1
88

9-
npx
9+
npx_functions
10+
npx_var
11+
npx_jit
12+
npx_annot
13+
npx_numpy
1014
ort
1115
plotting
1216
tools

‎_doc/api/npx_annot.rst

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
.. _l-api-npx-types:
2+
3+
npx.npx_types
4+
=============
5+
6+
Annotations
7+
+++++++++++
8+
9+
.. autoclass:: onnx_array_api.npx.npx_types.ElemType
10+
:members:
11+
12+
.. autoclass:: onnx_array_api.npx.npx_types.ParType
13+
:members:
14+
15+
.. autoclass:: onnx_array_api.npx.npx_types.OptParType
16+
:members:
17+
18+
.. autoclass:: onnx_array_api.npx.npx_types.TensorType
19+
:members:
20+
21+
.. autoclass:: onnx_array_api.npx.npx_types.SequenceType
22+
:members:
23+
24+
.. autoclass:: onnx_array_api.npx.npx_types.TupleType
25+
:members:
26+
27+
Shortcuts
28+
+++++++++
29+
30+
.. autoclass:: onnx_array_api.npx.npx_types.Bool
31+
32+
.. autoclass:: onnx_array_api.npx.npx_types.BFloat16
33+
34+
.. autoclass:: onnx_array_api.npx.npx_types.Float16
35+
36+
.. autoclass:: onnx_array_api.npx.npx_types.Float32
37+
38+
.. autoclass:: onnx_array_api.npx.npx_types.Float64
39+
40+
.. autoclass:: onnx_array_api.npx.npx_types.Int8
41+
42+
.. autoclass:: onnx_array_api.npx.npx_types.Int16
43+
44+
.. autoclass:: onnx_array_api.npx.npx_types.Int32
45+
46+
.. autoclass:: onnx_array_api.npx.npx_types.Int64
47+
48+
.. autoclass:: onnx_array_api.npx.npx_types.UInt8
49+
50+
.. autoclass:: onnx_array_api.npx.npx_types.UInt16
51+
52+
.. autoclass:: onnx_array_api.npx.npx_types.UInt32
53+
54+
.. autoclass:: onnx_array_api.npx.npx_types.UInt64

‎_doc/api/npx.rst renamed to ‎_doc/api/npx_functions.rst

+3-105
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
1-
.. _l-api-npx:
1+
.. _l-api-npx-functions:
22

3-
npx
4-
===
5-
6-
Functions
7-
+++++++++
3+
npx.npx_functions
4+
=================
85

96
.. autofunction:: onnx_array_api.npx.npx_functions.abs
107

@@ -111,102 +108,3 @@ Functions
111108
.. autofunction:: onnx_array_api.npx.npx_functions.vstack
112109

113110
.. autofunction:: onnx_array_api.npx.npx_functions.where
114-
115-
Var
116-
+++
117-
118-
.. autoclass:: onnx_array_api.npx.npx_var.Var
119-
:members:
120-
121-
Cst, Input
122-
++++++++++
123-
124-
.. autoclass:: onnx_array_api.npx.npx_var.Cst
125-
:members:
126-
127-
.. autoclass:: onnx_array_api.npx.npx_var.Input
128-
:members:
129-
130-
API
131-
+++
132-
133-
.. autofunction:: onnx_array_api.npx.npx_core_api.var
134-
135-
.. autofunction:: onnx_array_api.npx.npx_core_api.cst
136-
137-
.. autofunction:: onnx_array_api.npx.npx_jit_eager.jit_eager
138-
139-
.. autofunction:: onnx_array_api.npx.npx_jit_eager.jit_onnx
140-
141-
.. autofunction:: onnx_array_api.npx.npx_core_api.make_tuple
142-
143-
.. autofunction:: onnx_array_api.npx.npx_core_api.tuple_var
144-
145-
.. autofunction:: onnx_array_api.npx.npx_core_api.npxapi_inline
146-
147-
.. autofunction:: onnx_array_api.npx.npx_core_api.npxapi_function
148-
149-
JIT, Eager
150-
++++++++++
151-
152-
.. autoclass:: onnx_array_api.npx.npx_jit_eager.JitEager
153-
:members:
154-
155-
.. autoclass:: onnx_array_api.npx.npx_jit_eager.JitOnnx
156-
:members:
157-
158-
Tensors
159-
+++++++
160-
161-
.. autoclass:: onnx_array_api.npx.npx_tensors.NumpyTensor
162-
:members:
163-
164-
Annotations
165-
+++++++++++
166-
167-
.. autoclass:: onnx_array_api.npx.npx_types.ElemType
168-
:members:
169-
170-
.. autoclass:: onnx_array_api.npx.npx_types.ParType
171-
:members:
172-
173-
.. autoclass:: onnx_array_api.npx.npx_types.OptParType
174-
:members:
175-
176-
.. autoclass:: onnx_array_api.npx.npx_types.TensorType
177-
:members:
178-
179-
.. autoclass:: onnx_array_api.npx.npx_types.SequenceType
180-
:members:
181-
182-
.. autoclass:: onnx_array_api.npx.npx_types.TupleType
183-
:members:
184-
185-
Shortcuts
186-
+++++++++
187-
188-
.. autoclass:: onnx_array_api.npx.npx_types.Bool
189-
190-
.. autoclass:: onnx_array_api.npx.npx_types.BFloat16
191-
192-
.. autoclass:: onnx_array_api.npx.npx_types.Float16
193-
194-
.. autoclass:: onnx_array_api.npx.npx_types.Float32
195-
196-
.. autoclass:: onnx_array_api.npx.npx_types.Float64
197-
198-
.. autoclass:: onnx_array_api.npx.npx_types.Int8
199-
200-
.. autoclass:: onnx_array_api.npx.npx_types.Int16
201-
202-
.. autoclass:: onnx_array_api.npx.npx_types.Int32
203-
204-
.. autoclass:: onnx_array_api.npx.npx_types.Int64
205-
206-
.. autoclass:: onnx_array_api.npx.npx_types.UInt8
207-
208-
.. autoclass:: onnx_array_api.npx.npx_types.UInt16
209-
210-
.. autoclass:: onnx_array_api.npx.npx_types.UInt32
211-
212-
.. autoclass:: onnx_array_api.npx.npx_types.UInt64

‎_doc/api/npx_jit.rst

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
.. _l-api-npx-jit:
2+
3+
npx, jit and eager mode
4+
=======================
5+
6+
7+
API
8+
+++
9+
10+
.. autofunction:: onnx_array_api.npx.npx_core_api.var
11+
12+
.. autofunction:: onnx_array_api.npx.npx_core_api.cst
13+
14+
.. autofunction:: onnx_array_api.npx.npx_jit_eager.eager_onnx
15+
16+
.. autofunction:: onnx_array_api.npx.npx_jit_eager.jit_onnx
17+
18+
.. autofunction:: onnx_array_api.npx.npx_core_api.make_tuple
19+
20+
.. autofunction:: onnx_array_api.npx.npx_core_api.tuple_var
21+
22+
.. autofunction:: onnx_array_api.npx.npx_core_api.npxapi_inline
23+
24+
.. autofunction:: onnx_array_api.npx.npx_core_api.npxapi_function
25+
26+
JIT, Eager
27+
++++++++++
28+
29+
.. autoclass:: onnx_array_api.npx.npx_jit_eager.JitEager
30+
:members:
31+
32+
.. autoclass:: onnx_array_api.npx.npx_jit_eager.JitOnnx
33+
:members:

‎_doc/api/npx_numpy.rst

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _l-api-npx-numpy:
2+
3+
npx.npx_numpy_tensors
4+
=====================
5+
6+
.. autoclass:: onnx_array_api.npx.npx_numpy_tensors.EagerNumpyTensor
7+
:members:
8+
9+
.. autoclass:: onnx_array_api.npx.npx_numpy_tensors.JitNumpyTensor
10+
:members:
11+
12+
.. autoclass:: onnx_array_api.npx.npx_numpy_tensors.NumpyTensor
13+
:members:

‎_doc/api/npx_var.rst

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
.. _l-api-npx-var:
2+
3+
npx
4+
===
5+
6+
Var
7+
+++
8+
9+
.. autoclass:: onnx_array_api.npx.npx_var.Var
10+
:members:
11+
12+
Cst, Input
13+
++++++++++
14+
15+
.. autoclass:: onnx_array_api.npx.npx_var.Cst
16+
:members:
17+
18+
.. autoclass:: onnx_array_api.npx.npx_var.Input
19+
:members:

‎_doc/conf.py

+2
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,10 @@
6565
"onnx-array-api": (
6666
"http://www.xavierdupre.fr/app/" "onnx-array-api/helpsphinx/index.html"
6767
),
68+
"pyinstrument": "https://github.com/joerick/pyinstrument",
6869
"python": "https://www.python.org/",
6970
"scikit-learn": "https://scikit-learn.org/stable/",
71+
"scipy": "https://scipy.org/",
7072
"sphinx-gallery": "https://github.com/sphinx-gallery/sphinx-gallery",
7173
"torch": "https://pytorch.org/docs/stable/torch.html",
7274
}

‎_doc/examples/plot_onnxruntime.py

+9-1
Original file line numberDiff line numberDiff line change
@@ -100,4 +100,12 @@ def loop():
100100
# Plots
101101
# +++++
102102

103-
piv.plot(title="Comparison between numpy and onnxruntime", logx=True, logy=True)
103+
import matplotlib.pyplot as plt
104+
105+
fig, ax = plt.subplots(1, 2, figsize=(12, 4))
106+
piv.plot(
107+
title="Comparison between numpy and onnxruntime", logx=True, logy=True, ax=ax[0]
108+
)
109+
piv["ort/numpy"] = piv["ort"] / piv["numpy"]
110+
piv["ort/numpy"].plot(title="Ratio ort/numpy", logx=True, ax=ax[1])
111+
fig.savefig("plot_onnxruntime.png")

‎_doc/index.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ onnx-array-api: (Numpy) Array API for ONNX
2323
.. toctree::
2424
:maxdepth: 2
2525

26-
tutorial
27-
api
26+
tutorial/index
27+
api/index
2828
auto_examples/index
2929

3030
Sources available on

0 commit comments

Comments
 (0)