You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mxnet.apache.org by GitBox <gi...@apache.org> on 2017/12/01 18:48:41 UTC
[GitHub] piiswrong closed pull request #8906: [Doc] improvement for default param 'TShape()'
piiswrong closed pull request #8906: [Doc] improvement for default param 'TShape()'
URL: https://github.com/apache/incubator-mxnet/pull/8906
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/src/operator/contrib/deformable_convolution-inl.h b/src/operator/contrib/deformable_convolution-inl.h
index cc9a93a830..20386d47bc 100644
--- a/src/operator/contrib/deformable_convolution-inl.h
+++ b/src/operator/contrib/deformable_convolution-inl.h
@@ -68,15 +68,15 @@ struct DeformableConvolutionParam : public dmlc::Parameter<DeformableConvolution
bool no_bias;
dmlc::optional<int> layout;
DMLC_DECLARE_PARAMETER(DeformableConvolutionParam) {
- DMLC_DECLARE_FIELD(kernel).describe("convolution kernel size: (h, w) or (d, h, w)");
+ DMLC_DECLARE_FIELD(kernel).describe("Convolution kernel size: (h, w) or (d, h, w)");
DMLC_DECLARE_FIELD(stride).set_default(TShape())
- .describe("convolution stride: (h, w) or (d, h, w)");
+ .describe("Convolution stride: (h, w) or (d, h, w). Defaults to 1 for each dimension.");
DMLC_DECLARE_FIELD(dilate).set_default(TShape())
- .describe("convolution dilate: (h, w) or (d, h, w)");
+ .describe("Convolution dilate: (h, w) or (d, h, w). Defaults to 1 for each dimension.");
DMLC_DECLARE_FIELD(pad).set_default(TShape())
- .describe("pad for convolution: (h, w) or (d, h, w)");
+ .describe("Zero pad for convolution: (h, w) or (d, h, w). Defaults to no padding.");
DMLC_DECLARE_FIELD(num_filter).set_range(1, 100000)
- .describe("convolution filter(channel) number");
+ .describe("Convolution filter(channel) number");
DMLC_DECLARE_FIELD(num_group).set_default(1)
.describe("Number of group partitions.");
DMLC_DECLARE_FIELD(num_deformable_group).set_default(1)
diff --git a/src/operator/nn/convolution-inl.h b/src/operator/nn/convolution-inl.h
index 3818088429..38971aefa2 100644
--- a/src/operator/nn/convolution-inl.h
+++ b/src/operator/nn/convolution-inl.h
@@ -67,15 +67,15 @@ struct ConvolutionParam : public dmlc::Parameter<ConvolutionParam> {
bool cudnn_off;
dmlc::optional<int> layout;
DMLC_DECLARE_PARAMETER(ConvolutionParam) {
- DMLC_DECLARE_FIELD(kernel).describe("convolution kernel size: (h, w) or (d, h, w)");
+ DMLC_DECLARE_FIELD(kernel).describe("Convolution kernel size: (h, w) or (d, h, w)");
DMLC_DECLARE_FIELD(stride).set_default(TShape())
- .describe("convolution stride: (h, w) or (d, h, w)");
+ .describe("Convolution stride: (h, w) or (d, h, w). Defaults to 1 for each dimension.");
DMLC_DECLARE_FIELD(dilate).set_default(TShape())
- .describe("convolution dilate: (h, w) or (d, h, w)");
+ .describe("Convolution dilate: (h, w) or (d, h, w). Defaults to 1 for each dimension.");
DMLC_DECLARE_FIELD(pad).set_default(TShape())
- .describe("pad for convolution: (h, w) or (d, h, w)");
+ .describe("Zero pad for convolution: (h, w) or (d, h, w). Defaults to no padding.");
DMLC_DECLARE_FIELD(num_filter).set_range(1, 100000)
- .describe("convolution filter(channel) number");
+ .describe("Convolution filter(channel) number");
DMLC_DECLARE_FIELD(num_group).set_default(1)
.describe("Number of group partitions.");
DMLC_DECLARE_FIELD(workspace).set_default(1024).set_range(0, 8192)
diff --git a/src/operator/nn/deconvolution-inl.h b/src/operator/nn/deconvolution-inl.h
index 9a3c17997d..b7d2676fad 100644
--- a/src/operator/nn/deconvolution-inl.h
+++ b/src/operator/nn/deconvolution-inl.h
@@ -66,9 +66,11 @@ struct DeconvolutionParam : public dmlc::Parameter<DeconvolutionParam> {
DMLC_DECLARE_FIELD(kernel).describe("Deconvolution kernel size: (h, w) or (d, h, w). "
"This is same as the kernel size used for the corresponding convolution");
DMLC_DECLARE_FIELD(stride).set_default(TShape())
- .describe("The stride used for the corresponding convolution: (h, w) or (d, h, w).");
+ .describe("The stride used for the corresponding convolution: (h, w) or (d, h, w). "
+ "Defaults to 1 for each dimension.");
DMLC_DECLARE_FIELD(dilate).set_default(TShape())
- .describe("Dilation factor for each dimension of the input: (h, w) or (d, h, w).");
+ .describe("Dilation factor for each dimension of the input: (h, w) or (d, h, w). "
+ "Defaults to 1 for each dimension.");
DMLC_DECLARE_FIELD(pad).set_default(TShape())
.describe("The amount of implicit zero padding added during convolution for each "
"dimension of the input: "
@@ -76,7 +78,7 @@ struct DeconvolutionParam : public dmlc::Parameter<DeconvolutionParam> {
"``(kernel-1)/2`` is usually a good choice. "
"If `target_shape` is set, "
"`pad` will be ignored and a padding that will generate the target shape "
- "will be used.");
+ "will be used. Defaults to no padding.");
DMLC_DECLARE_FIELD(adj).set_default(TShape())
.describe("Adjustment for output shape: (h, w) or (d, h, w). "
"If `target_shape` is set, "
diff --git a/src/operator/nn/pooling-inl.h b/src/operator/nn/pooling-inl.h
index 882504305d..a32aaa2152 100644
--- a/src/operator/nn/pooling-inl.h
+++ b/src/operator/nn/pooling-inl.h
@@ -58,7 +58,7 @@ struct PoolingParam : public dmlc::Parameter<PoolingParam> {
DMLC_DECLARE_FIELD(kernel)
.enforce_nonzero()
- .describe("pooling kernel size: (y, x) or (d, y, x)");
+ .describe("Pooling kernel size: (y, x) or (d, y, x)");
DMLC_DECLARE_FIELD(pool_type)
.add_enum("max", pool_enum::kMaxPooling)
@@ -73,10 +73,10 @@ struct PoolingParam : public dmlc::Parameter<PoolingParam> {
DMLC_DECLARE_FIELD(stride).set_default(TShape())
.enforce_nonzero()
- .describe("stride: for pooling (y, x) or (d, y, x)");
+ .describe("Stride: for pooling (y, x) or (d, y, x). Defaults to 1 for each dimension.");
DMLC_DECLARE_FIELD(pad).set_default(TShape())
- .describe("pad for pooling: (y, x) or (d, y, x)");
+ .describe("Pad for pooling: (y, x) or (d, y, x). Defaults to no padding.");
}
};
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services