nswamy closed pull request #12879: add/update infer_range docs
URL: https://github.com/apache/incubator-mxnet/pull/12879
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/python/mxnet/ndarray/ndarray.py b/python/mxnet/ndarray/ndarray.py
index c5924653f38..bf1140d2071 100644
--- a/python/mxnet/ndarray/ndarray.py
+++ b/python/mxnet/ndarray/ndarray.py
@@ -2547,6 +2547,9 @@ def arange(start, stop=None, step=1.0, repeat=1,
infer_range=False, ctx=None, dt
Spacing between values. The default step size is 1.
repeat : int, optional
Number of times to repeat each element. The default repeat count is 1.
+ infer_range : boolean, optional
+ When set to True, infer the stop position from the start, step,
+ repeat, and output tensor size.
ctx : Context, optional
Device context. Default context is the current default context.
dtype : str or numpy.dtype, optional
diff --git a/python/mxnet/symbol/symbol.py b/python/mxnet/symbol/symbol.py
index eaf22f3bec1..c6575072cc7 100644
--- a/python/mxnet/symbol/symbol.py
+++ b/python/mxnet/symbol/symbol.py
@@ -2926,6 +2926,9 @@ def arange(start, stop=None, step=1.0, repeat=1,
infer_range=False, name=None, d
repeat : int, optional
"The repeating time of all elements.
E.g repeat=3, the element a will be repeated three times --> a, a, a.
+ infer_range : boolean, optional
+ When set to True, infer the stop position from the start, step,
+ repeat, and output tensor size.
dtype : str or numpy.dtype, optional
The value type of the inner value, default to ``np.float32``.
diff --git a/scala-package/core/src/main/scala/org/apache/mxnet/NDArray.scala
b/scala-package/core/src/main/scala/org/apache/mxnet/NDArray.scala
index 9b6a7dc6654..3bda52dcc4e 100644
--- a/scala-package/core/src/main/scala/org/apache/mxnet/NDArray.scala
+++ b/scala-package/core/src/main/scala/org/apache/mxnet/NDArray.scala
@@ -403,6 +403,9 @@ object NDArray extends NDArrayBase {
* @param stop End of interval.
* @param step Spacing between values. The default step size is 1.
* @param repeat Number of times to repeat each element. The default repeat
count is 1.
+ * @param infer_range
+ * When set to True, infer the stop position from the start, step,
+ * repeat, and output tensor size.
* @param ctx Device context. Default context is the current default context.
* @param dType The data type of the `NDArray`. The default datatype is
`DType.Float32`.
* @return NDArray of evenly spaced values in the specified range.
diff --git a/scala-package/core/src/main/scala/org/apache/mxnet/Symbol.scala
b/scala-package/core/src/main/scala/org/apache/mxnet/Symbol.scala
index b1a3e392f41..a22ff656982 100644
--- a/scala-package/core/src/main/scala/org/apache/mxnet/Symbol.scala
+++ b/scala-package/core/src/main/scala/org/apache/mxnet/Symbol.scala
@@ -979,7 +979,9 @@ object Symbol extends SymbolBase {
* @param stop End of interval.
* @param step Spacing between values. The default step size is 1.
* @param repeat Number of times to repeat each element. The default repeat
count is 1.
- * @param infer_range Infer the stop value from output shape
+ * @param infer_range
+ * When set to True, infer the stop position from the start, step,
+ * repeat, and output tensor size.
* @param ctx Device context. Default context is the current default context.
* @param dType The data type of the `NDArray`. The default datatype is
`DType.Float32`.
* @return NDArray of evenly spaced values in the specified range.
diff --git a/src/operator/tensor/init_op.h b/src/operator/tensor/init_op.h
index 1a4790acdb2..4e52b087f10 100644
--- a/src/operator/tensor/init_op.h
+++ b/src/operator/tensor/init_op.h
@@ -161,8 +161,8 @@ struct RangeParam : public dmlc::Parameter<RangeParam> {
" E.g repeat=3, the element a will be repeated three times -->
a, a, a.");
DMLC_DECLARE_FIELD(infer_range)
.set_default(false)
- .describe("Whether to infer the stop position from the start, step,
repeat, and output tensor"
- "size.");
+ .describe("When set to True, infer the stop position from the start, step,
"
+ "repeat, and output tensor size.");
DMLC_DECLARE_FIELD(ctx)
.set_default("")
.describe("Context of output, in format [cpu|gpu|cpu_pinned](n)."
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
