Skip to content
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
@domdivakaruni

Description

@domdivakaruni

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!

alt text

Here’s how you can join in and help:

  1. 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.
  2. Look up current documentation

  3. 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
  4. 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

API List

# Function Name Package Contributor Status
1
  • IRHeader
recordio
2
  • pack
recordio
3
  • pack_img
recordio
4
  • unpack
recordio
5
  • unpack_img
recordio
6
  • BilinearSampler
ndarray @Lyken17
7
  • Correlation
ndarray @Lyken17
8
  • GridGenerator
ndarray @Lyken17
9
  • IdentityAttachKLSparseReg
ndarray @Lyken17
10
  • SpatialTransformer
ndarray @Lyken17
11
  • UpSampling
ndarray @Lyken17
12
  • adam_update
ndarray
13
  • ones_like
ndarray @yuruofeifei
14
  • random_exponential
ndarray @asmushetzel
15
  • random_gamma
ndarray @asmushetzel
16
  • random_generalized_negative_binomial
ndarray @asmushetzel
17
  • random_negative_binomial
ndarray @asmushetzel
18
  • random_poisson
ndarray @asmushetzel
19
  • rmsprop_update
ndarray @jiajiechen
20
  • rmspropalex_update
ndarray @jiajiechen
21
  • sample_exponential
ndarray @asmushetzel
22
  • sample_gamma
ndarray @asmushetzel
23
  • sample_generalized_negative_binomial
ndarray @asmushetzel
24
  • sample_negative_binomial
ndarray @asmushetzel
25
  • sample_normal
ndarray @asmushetzel
26
  • sample_poisson
ndarray @asmushetzel
27
  • sample_uniform
ndarray @asmushetzel
28
  • sgd_mom_update
ndarray
29
  • sgd_update
ndarray
30
  • smooth_l1
ndarray
31
  • softmax_cross_entropy
ndarray @yuruofeifei
32
  • waitall
ndarray
33
  • zeros_like
ndarray @yuruofeifei
34
  • Caffe
metric
35
  • Torch
metric
36
  • check_label_shapes
metric
37
  • Bilinear
initializer
38
  • FusedRNN
initializer
39
  • LSTMBias
initializer
40
  • LogValidationMetricsCallback
callback
41
  • _init_torch_module
torch
42
  • _make_torch_function
torch
43
  • CustomOp.assign
operator
44
  • NameManager
name
45
  • Monitor
monitor
46
  • CastAug
image
47
  • CenterCropAug
image
48
  • ColorJitterAug
image
49
  • ColorNormalizeAug
image
50
  • CreateAugmenter
image
51
  • HorizontalFlipAug
image
52
  • LightingAug
image
53
  • RandomCropAug
image
54
  • RandomOrderAug
image
55
  • RandomSizedCropAug
image
56
  • ResizeAug
image
57
  • center_crop
image
58
  • color_normalize
image
59
  • fixed_crop
image
60
  • imdecode
image
61
  • random_crop
image
62
  • random_size_crop
image
63
  • resize_short
image @jhwei
64
  • scale_down
image @jhwei
65
  • ImageIter.augmentation_transform
image
66
  • ImageIter.imdecode
image
67
  • ImageIter.postprocess_data
image
68
  • ImageIter.read_image
image
69
  • ImageIter.check_data_shape
image
70
  • ImageIter.check_valid_image
image
71
  • Executor._get_dict
executor
72
  • _monitor_callback_wrapper
executor
73
  • MultiBoxDetection
contrib
74
  • MultiBoxPrior
contrib
75
  • MultiBoxTarget
contrib
76
  • Proposal
contrib
77
  • count_sketch
contrib
78
  • fft
contrib
79
  • ifft
contrib
80
  • set_is_training
contrib
81
  • test
contrib
82
  • train
contrib
83
  • MXNetError
base
84
  • mx_float_p
base
85
  • py_str
base
86
  • print_summary
visualization
87
  • Symbol.attr
symbol
88
  • Symbol.attr_dict
symbol
89
  • Symbol.debug_str
symbol
90
  • Symbol.grad
symbol
91
  • Symbol.list_attr
symbol
92
  • MXRecordIO.close
recordio
93
  • MXRecordIO.open
recordio
94
  • Optimizer.set_lr_mult
optimizer
95
  • Optimizer.set_lr_scale
optimizer
96
  • Optimizer.set_wd_mult
optimizer
97
  • Optimizer.update
optimizer
98
  • LinearRegressionOutput
ndarray @naidu0830
99
  • NDArray._at
ndarray @reminisce
100
  • NDArray._slice
ndarray @reminisce
101
  • NDArray._sync_copyfrom
ndarray @reminisce
102
  • gamma
ndarray @zhenwendai
103
  • gammaln
ndarray @zhenwendai
104
  • identity
ndarray @zhenwendai
105
  • load
ndarray @zhenwendai
106
  • moveaxis
ndarray @zhenwendai
107
  • DataDesc
io
108
  • DataDesc.get_batch_axis
io
109
  • DataDesc.get_list
io
110
  • DataIter.getpad
io
111
  • MXDataIter
io
112
  • ImageDetRecordIter
io
113
  • Initializer._legacy_init
initializer
114
  • Initializer.dumps
initializer
115
  • ProgressBar
callback @saurabh3949
116
  • log_train_metric
callback
117
  • module_checkpoint
callback
118
  • _parse_aux_states
test_utils
119
  • _parse_location
test_utils
120
  • check_symbolic_backward
test_utils @reminisce
121
  • check_symbolic_forward
test_utils @reminisce
122
  • np_reduce
test_utils
123
  • numeric_grad
test_utils
124
  • print_max_err_loc
test_utils
125
  • BucketSentenceIter
rnn
126
  • encode_sentences
rnn
127
  • do_rnn_checkpoint
rnn
128
  • load_rnn_checkpoint
rnn
129
  • save_rnn_checkpoint
rnn
130
  • BaseRNNCell.begin_state
rnn
131
  • BaseRNNCell.pack_weights
rnn
132
  • BaseRNNCell.unpack_weights
rnn
133
  • BaseRNNCell.unroll
rnn
134
  • BidirectionalCell
rnn
135
  • DropoutCell
rnn
136
  • FusedRNNCell
rnn
137
  • GRUCell
rnn
138
  • LSTMCell
rnn
139
  • ModifierCell
rnn
140
  • RNNCell
rnn
141
  • RNNParams
rnn
142
  • RNNParams.get
rnn
143
  • SequentialRNNCell
rnn
144
  • SequentialRNNCell.add
rnn
145
  • ZoneoutCell
rnn
146
  • BaseRNNCell._get_activation
rnn
147
  • FusedRNNCell._slice_weights
rnn
148
  • dump_profile
profiler
149
  • profiler_set_config
profiler
150
  • profiler_set_state
profiler
151
  • CustomOp
operator
152
  • CustomOp.backward
operator
153
  • CustomOp.forward
operator
154
  • CustomOpProp
operator
155
  • CustomOpProp.infer_shape
operator
156
  • CustomOpProp.list_arguments
operator
157
  • CustomOpProp.list_auxiliary_states
operator
158
  • CustomOpProp.list_outputs
operator
159
  • NDArrayOp.declare_backward_
operator
160
  • NumpyOp
operator
161
  • PythonOp
operator
162
  • PythonOp.backward
operator
163
  • PythonOp.forward
operator
164
  • PythonOp.get_symbol
operator
165
  • PythonOp.infer_shape
operator
166
  • PythonOp.list_arguments
operator
167
  • PythonOp.list_outputs
operator
168
  • PythonOp.need_top_grad
operator
169
  • register
operator
170
  • CustomOpProp.infer_type
operator
171
  • NameManager.get
name
172
  • Prefix
name
173
  • Monitor.install
monitor
174
  • Monitor.tic
monitor
175
  • Monitor.toc
monitor
176
  • Monitor.toc_print
monitor
177
  • getLogger
log
178
  • KVStore.load_optimizer_states
kvstore @eric-haibin-lin
179
  • KVStore.save_optimizer_states
kvstore @eric-haibin-lin
180
  • - [x ] KVStore.set_optimizer
kvstore @eric-haibin-lin
181
  • create
kvstore @eric-haibin-lin
182
  • ImageIter
image
183
  • ImageIter.next
image
184
  • ImageIter.next_sample
image
185
  • ImageIter.reset
image
186
  • Executor
executor @kevinthesun
187
  • Executor.backward
executor @kevinthesun
188
  • Executor.copy_params_from
executor @kevinthesun
189
  • Executor.reshape
executor @kevinthesun
190
  • Executor.set_monitor_callback
executor @kevinthesun
191
  • Executor._get_outputs
executor
192
  • Executor.debug_str
executor @kevinthesun
193
  • compute_gradient
contrib
194
  • grad_and_loss
contrib
195
  • mark_variables
contrib
196
  • set_recording
contrib
197
  • LogMetricsCallback
contrib
198
  • TrainingStateScope
contrib
199
  • build_param_doc
base
200
  • c_array
base @yuruofeifei
201
  • c_str
base @yuruofeifei
202
  • check_call
base
203
  • ctypes2buffer
base
204
  • ctypes2numpy_shared
base
205
  • _load_lib
base
206
  • _notify_shutdown
base
207
  • add_fileline_to_docstring
base
208
  • AttrScope
attribute
209
  • AttrScope.current
attribute
210
  • AttrScope.get
attribute

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions