This repository was archived by the owner on Nov 17, 2023. It is now read-only.
This repository was archived by the owner on Nov 17, 2023. It is now read-only.
API Doc Improvements - Tracking #6000
Closed
Description
Let's fix our docs!
The effort to spruce up MXNet's Python API docs is picking up steam but could use your help to add that extra oomph! Many of the APIs now have proper explanations and good examples, but we still have much more to go!
Here’s how you can join in and help:
-
Pick a few functions (or at least 1 😄 ) from the list below
- Ensure you only pick ones that don’t have a current owner assigned and you can submit within 2 business days. Post a comment to the issue with the ones you’ve selected.
-
Look up current documentation
- Find whats currently documented for the function at the mxnet.io python API docs or within the C++ code in git.
-
Write up:
- A clear and concise description of the function and its behavior.
- List and describe each parameter with the valid input values, whether it is required or optional, and default value if the parameter is optional.
- Illustrate the function and parameter behavior using examples
- Refer to these examples for guidance:- Embedding , ROIPooling , Reshape
-
Submit your work
- Creating a new issue with [API docs submission] ‘your function name(s)’ in the title and paste your write-up markdown
OR - Creating a pull request for a change to the appropriate .cc or .py file. Instructions here: How to make a pull request for docs
- Creating a new issue with [API docs submission] ‘your function name(s)’ in the title and paste your write-up markdown
API List
# | Function Name | Package | Contributor | Status |
---|---|---|---|---|
1 |
|
recordio | ||
2 |
|
recordio | ||
3 |
|
recordio | ||
4 |
|
recordio | ||
5 |
|
recordio | ||
6 |
|
ndarray | @Lyken17 | |
7 |
|
ndarray | @Lyken17 | |
8 |
|
ndarray | @Lyken17 | |
9 |
|
ndarray | @Lyken17 | |
10 |
|
ndarray | @Lyken17 | |
11 |
|
ndarray | @Lyken17 | |
12 |
|
ndarray | ||
13 |
|
ndarray | @yuruofeifei | |
14 |
|
ndarray | @asmushetzel | |
15 |
|
ndarray | @asmushetzel | |
16 |
|
ndarray | @asmushetzel | |
17 |
|
ndarray | @asmushetzel | |
18 |
|
ndarray | @asmushetzel | |
19 |
|
ndarray | @jiajiechen | |
20 |
|
ndarray | @jiajiechen | |
21 |
|
ndarray | @asmushetzel | |
22 |
|
ndarray | @asmushetzel | |
23 |
|
ndarray | @asmushetzel | |
24 |
|
ndarray | @asmushetzel | |
25 |
|
ndarray | @asmushetzel | |
26 |
|
ndarray | @asmushetzel | |
27 |
|
ndarray | @asmushetzel | |
28 |
|
ndarray | ||
29 |
|
ndarray | ||
30 |
|
ndarray | ||
31 |
|
ndarray | @yuruofeifei | |
32 |
|
ndarray | ||
33 |
|
ndarray | @yuruofeifei | |
34 |
|
metric | ||
35 |
|
metric | ||
36 |
|
metric | ||
37 |
|
initializer | ||
38 |
|
initializer | ||
39 |
|
initializer | ||
40 |
|
callback | ||
41 |
|
torch | ||
42 |
|
torch | ||
43 |
|
operator | ||
44 |
|
name | ||
45 |
|
monitor | ||
46 |
|
image | ||
47 |
|
image | ||
48 |
|
image | ||
49 |
|
image | ||
50 |
|
image | ||
51 |
|
image | ||
52 |
|
image | ||
53 |
|
image | ||
54 |
|
image | ||
55 |
|
image | ||
56 |
|
image | ||
57 |
|
image | ||
58 |
|
image | ||
59 |
|
image | ||
60 |
|
image | ||
61 |
|
image | ||
62 |
|
image | ||
63 |
|
image | @jhwei | |
64 |
|
image | @jhwei | |
65 |
|
image | ||
66 |
|
image | ||
67 |
|
image | ||
68 |
|
image | ||
69 |
|
image | ||
70 |
|
image | ||
71 |
|
executor | ||
72 |
|
executor | ||
73 |
|
contrib | ||
74 |
|
contrib | ||
75 |
|
contrib | ||
76 |
|
contrib | ||
77 |
|
contrib | ||
78 |
|
contrib | ||
79 |
|
contrib | ||
80 |
|
contrib | ||
81 |
|
contrib | ||
82 |
|
contrib | ||
83 |
|
base | ||
84 |
|
base | ||
85 |
|
base | ||
86 |
|
visualization | ||
87 |
|
symbol | ||
88 |
|
symbol | ||
89 |
|
symbol | ||
90 |
|
symbol | ||
91 |
|
symbol | ||
92 |
|
recordio | ||
93 |
|
recordio | ||
94 |
|
optimizer | ||
95 |
|
optimizer | ||
96 |
|
optimizer | ||
97 |
|
optimizer | ||
98 |
|
ndarray | @naidu0830 | |
99 |
|
ndarray | @reminisce | |
100 |
|
ndarray | @reminisce | |
101 |
|
ndarray | @reminisce | |
102 |
|
ndarray | @zhenwendai | |
103 |
|
ndarray | @zhenwendai | |
104 |
|
ndarray | @zhenwendai | |
105 |
|
ndarray | @zhenwendai | |
106 |
|
ndarray | @zhenwendai | |
107 |
|
io | ||
108 |
|
io | ||
109 |
|
io | ||
110 |
|
io | ||
111 |
|
io | ||
112 |
|
io | ||
113 |
|
initializer | ||
114 |
|
initializer | ||
115 |
|
callback | @saurabh3949 | |
116 |
|
callback | ||
117 |
|
callback | ||
118 |
|
test_utils | ||
119 |
|
test_utils | ||
120 |
|
test_utils | @reminisce | |
121 |
|
test_utils | @reminisce | |
122 |
|
test_utils | ||
123 |
|
test_utils | ||
124 |
|
test_utils | ||
125 |
|
rnn | ||
126 |
|
rnn | ||
127 |
|
rnn | ||
128 |
|
rnn | ||
129 |
|
rnn | ||
130 |
|
rnn | ||
131 |
|
rnn | ||
132 |
|
rnn | ||
133 |
|
rnn | ||
134 |
|
rnn | ||
135 |
|
rnn | ||
136 |
|
rnn | ||
137 |
|
rnn | ||
138 |
|
rnn | ||
139 |
|
rnn | ||
140 |
|
rnn | ||
141 |
|
rnn | ||
142 |
|
rnn | ||
143 |
|
rnn | ||
144 |
|
rnn | ||
145 |
|
rnn | ||
146 |
|
rnn | ||
147 |
|
rnn | ||
148 |
|
profiler | ||
149 |
|
profiler | ||
150 |
|
profiler | ||
151 |
|
operator | ||
152 |
|
operator | ||
153 |
|
operator | ||
154 |
|
operator | ||
155 |
|
operator | ||
156 |
|
operator | ||
157 |
|
operator | ||
158 |
|
operator | ||
159 |
|
|||
160 |
|
|||
161 |
|
|||
162 |
|
|||
163 |
|
|||
164 |
|
|||
165 |
|
|||
166 |
|
|||
167 |
|
|||
168 |
|
|||
169 |
|
operator | ||
170 |
|
operator | ||
171 |
|
name | ||
172 |
|
name | ||
173 |
|
monitor | ||
174 |
|
monitor | ||
175 |
|
monitor | ||
176 |
|
monitor | ||
177 |
|
log | ||
178 |
|
kvstore | @eric-haibin-lin | |
179 |
|
kvstore | @eric-haibin-lin | |
180 |
|
kvstore | @eric-haibin-lin | |
181 |
|
kvstore | @eric-haibin-lin | |
182 |
|
image | ||
183 |
|
image | ||
184 |
|
image | ||
185 |
|
image | ||
186 |
|
executor | @kevinthesun | |
187 |
|
executor | @kevinthesun | |
188 |
|
executor | @kevinthesun | |
189 |
|
executor | @kevinthesun | |
190 |
|
executor | @kevinthesun | |
191 |
|
executor | ||
192 |
|
executor | @kevinthesun | |
193 |
|
contrib | ||
194 |
|
contrib | ||
195 |
|
contrib | ||
196 |
|
contrib | ||
197 |
|
contrib | ||
198 |
|
contrib | ||
199 |
|
base | ||
200 |
|
base | @yuruofeifei | |
201 |
|
base | @yuruofeifei | |
202 |
|
base | ||
203 |
|
base | ||
204 |
|
base | ||
205 |
|
base | ||
206 |
|
base | ||
207 |
|
base | ||
208 |
|
attribute | ||
209 |
|
attribute | ||
210 |
|
attribute |
Metadata
Metadata
Assignees
Labels
No labels