提交 447dae3a 编写于 作者: A A. Unique TensorFlower 提交者: TensorFlower Gardener

Update generated Python Op docs.

Change: 136745074
上级 53be8312
......@@ -130,7 +130,7 @@ dist.mean().eval()
```
- - -
#### `tf.contrib.distributions.Distribution.__init__(dtype, parameters, is_continuous, is_reparameterized, validate_args, allow_nan_stats, name=None)` {#Distribution.__init__}
#### `tf.contrib.distributions.Distribution.__init__(dtype, is_continuous, is_reparameterized, validate_args, allow_nan_stats, parameters=None, graph_parents=None, name=None)` {#Distribution.__init__}
Constructs the `Distribution`.
......@@ -140,7 +140,6 @@ Constructs the `Distribution`.
* <b>`dtype`</b>: The type of the event samples. `None` implies no type-enforcement.
* <b>`parameters`</b>: Python dictionary of parameters used by this `Distribution`.
* <b>`is_continuous`</b>: Python boolean. If `True` this
`Distribution` is continuous over its supported domain.
* <b>`is_reparameterized`</b>: Python boolean. If `True` this
......@@ -154,7 +153,15 @@ Constructs the `Distribution`.
exception if a statistic (e.g., mean, mode) is undefined for any batch
member. If True, batch members with valid parameters leading to
undefined statistics will return `NaN` for this statistic.
* <b>`name`</b>: A name for this distribution (optional).
* <b>`parameters`</b>: Python dictionary of parameters used to instantiate this
`Distribution`.
* <b>`graph_parents`</b>: Python list of graph prerequisites of this `Distribution`.
* <b>`name`</b>: A name for this distribution. Default: subclass name.
##### Raises:
* <b>`ValueError`</b>: if any member of graph_parents is `None` or not a `Tensor`.
- - -
......@@ -494,7 +501,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Distribution.parameters` {#Distribution.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -1143,7 +1150,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Binomial.parameters` {#Binomial.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -1723,7 +1730,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Bernoulli.parameters` {#Bernoulli.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -2268,7 +2275,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.BernoulliWithSigmoidP.parameters` {#BernoulliWithSigmoidP.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -2920,7 +2927,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Beta.parameters` {#Beta.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -3484,7 +3491,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.BetaWithSoftplusAB.parameters` {#BetaWithSoftplusAB.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -4095,7 +4102,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Categorical.parameters` {#Categorical.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -4675,7 +4682,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Chi2.parameters` {#Chi2.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -5238,7 +5245,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Chi2WithAbsDf.parameters` {#Chi2WithAbsDf.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -5823,7 +5830,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Exponential.parameters` {#Exponential.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -6386,7 +6393,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.ExponentialWithSoftplusLam.parameters` {#ExponentialWithSoftplusLam.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -6991,7 +6998,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Gamma.parameters` {#Gamma.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -7547,7 +7554,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.GammaWithSoftplusAlphaBeta.parameters` {#GammaWithSoftplusAlphaBeta.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -8152,7 +8159,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.InverseGamma.parameters` {#InverseGamma.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -8718,7 +8725,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.InverseGammaWithSoftplusAlphaBeta.parameters` {#InverseGammaWithSoftplusAlphaBeta.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -9289,7 +9296,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Laplace.parameters` {#Laplace.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -9823,7 +9830,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.LaplaceWithSoftplusScale.parameters` {#LaplaceWithSoftplusScale.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -10421,7 +10428,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Normal.parameters` {#Normal.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -10955,7 +10962,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.NormalWithSoftplusSigma.parameters` {#NormalWithSoftplusSigma.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -11526,7 +11533,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Poisson.parameters` {#Poisson.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -12145,7 +12152,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.StudentT.parameters` {#StudentT.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -12702,7 +12709,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.StudentTWithAbsDfSoftplusSigma.parameters` {#StudentTWithAbsDfSoftplusSigma.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -13295,7 +13302,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Uniform.parameters` {#Uniform.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -13926,7 +13933,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.MultivariateNormalDiag.parameters` {#MultivariateNormalDiag.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -14567,7 +14574,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.MultivariateNormalFull.parameters` {#MultivariateNormalFull.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -15217,7 +15224,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.MultivariateNormalCholesky.parameters` {#MultivariateNormalCholesky.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -15893,7 +15900,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.MultivariateNormalDiagPlusVDVT.parameters` {#MultivariateNormalDiagPlusVDVT.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -16473,7 +16480,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.MultivariateNormalDiagWithSoftplusStDev.parameters` {#MultivariateNormalDiagWithSoftplusStDev.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -17198,7 +17205,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Dirichlet.parameters` {#Dirichlet.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -17861,7 +17868,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.DirichletMultinomial.parameters` {#DirichletMultinomial.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -18548,7 +18555,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Multinomial.parameters` {#Multinomial.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -19197,7 +19204,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.WishartCholesky.parameters` {#WishartCholesky.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -19841,7 +19848,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.WishartFull.parameters` {#WishartFull.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -20137,7 +20144,7 @@ normal = ds.TransformedDistribution(
```
- - -
#### `tf.contrib.distributions.TransformedDistribution.__init__(distribution, bijector, name=None)` {#TransformedDistribution.__init__}
#### `tf.contrib.distributions.TransformedDistribution.__init__(distribution, bijector, validate_args=False, name=None)` {#TransformedDistribution.__init__}
Construct a Transformed Distribution.
......@@ -20148,6 +20155,9 @@ Construct a Transformed Distribution.
instance of `Distribution`.
* <b>`bijector`</b>: The object responsible for calculating the transformation.
Typically an instance of `Bijector`.
* <b>`validate_args`</b>: Python boolean. Whether to validate input with asserts.
If `validate_args` is `False`, and the inputs are invalid,
correct behavior is not guaranteed.
* <b>`name`</b>: The name for the distribution. Default:
`bijector.name + distribution.name`.
......@@ -20541,7 +20551,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.TransformedDistribution.parameters` {#TransformedDistribution.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -20801,13 +20811,13 @@ entropy are better done with samples or approximations, and are not
implemented by this class.
- - -
#### `tf.contrib.distributions.QuantizedDistribution.__init__(distribution, lower_cutoff=None, upper_cutoff=None, name='QuantizedDistribution')` {#QuantizedDistribution.__init__}
#### `tf.contrib.distributions.QuantizedDistribution.__init__(distribution, lower_cutoff=None, upper_cutoff=None, validate_args=False, name='QuantizedDistribution')` {#QuantizedDistribution.__init__}
Construct a Quantized Distribution representing `Y = ceiling(X)`.
Some properties are inherited from the distribution defining `X`.
In particular, `validate_args` and `allow_nan_stats` are determined for this
`QuantizedDistribution` by reading the `distribution`.
Some properties are inherited from the distribution defining `X`. Example:
`allow_nan_stats` is determined for this `QuantizedDistribution` by reading
the `distribution`.
##### Args:
......@@ -20823,6 +20833,9 @@ In particular, `validate_args` and `allow_nan_stats` are determined for this
If provided, base distribution's pdf/pmf should be defined at
`upper_cutoff - 1`.
`upper_cutoff` must be strictly greater than `lower_cutoff`.
* <b>`validate_args`</b>: Python boolean. Whether to validate input with asserts.
If `validate_args` is `False`, and the inputs are invalid,
correct behavior is not guaranteed.
* <b>`name`</b>: The name for the distribution.
##### Raises:
......@@ -21249,7 +21262,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.QuantizedDistribution.parameters` {#QuantizedDistribution.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......@@ -21922,7 +21935,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Mixture.parameters` {#Mixture.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -647,7 +647,7 @@ Run one step of LSTM.
- - -
#### `tf.contrib.rnn.GridLSTMCell.__init__(num_units, use_peepholes=False, share_time_frequency_weights=False, cell_clip=None, initializer=None, num_unit_shards=1, forget_bias=1.0, feature_size=None, frequency_skip=None, num_frequency_blocks=1, couple_input_forget_gates=False, state_is_tuple=False)` {#GridLSTMCell.__init__}
#### `tf.contrib.rnn.GridLSTMCell.__init__(num_units, use_peepholes=False, share_time_frequency_weights=False, cell_clip=None, initializer=None, num_unit_shards=1, forget_bias=1.0, feature_size=None, frequency_skip=None, num_frequency_blocks=None, start_freqindex_list=None, end_freqindex_list=None, couple_input_forget_gates=False, state_is_tuple=False)` {#GridLSTMCell.__init__}
Initialize the parameters for an LSTM cell.
......@@ -672,8 +672,13 @@ Initialize the parameters for an LSTM cell.
the LSTM spans over.
* <b>`frequency_skip`</b>: (optional) int, default None, The amount the LSTM filter
is shifted by in frequency.
* <b>`num_frequency_blocks`</b>: (optional) int, default 1, The total number of
frequency blocks needed to cover the whole input feature.
* <b>`num_frequency_blocks`</b>: [required] A list of frequency blocks needed to
cover the whole input feature splitting defined by start_freqindex_list
and end_freqindex_list.
* <b>`start_freqindex_list`</b>: [optional], list of ints, default None, The
starting frequency index for each frequency block.
* <b>`end_freqindex_list`</b>: [optional], list of ints, default None. The ending
frequency index for each frequency block.
* <b>`couple_input_forget_gates`</b>: (optional) bool, default False, Whether to
couple the input and forget gates, i.e. f_gate = 1.0 - i_gate, to reduce
model parameters and computation cost.
......@@ -681,6 +686,11 @@ Initialize the parameters for an LSTM cell.
the `c_state` and `m_state`. By default (False), they are concatenated
along the column axis. This default behavior will soon be deprecated.
##### Raises:
* <b>`ValueError`</b>: if the num_frequency_blocks list is not specified
- - -
......@@ -854,7 +864,7 @@ Run one step of LSTM.
- - -
#### `tf.contrib.rnn.BidirectionalGridLSTMCell.__init__(num_units, use_peepholes=False, share_time_frequency_weights=False, cell_clip=None, initializer=None, num_unit_shards=1, forget_bias=1.0, feature_size=None, frequency_skip=None, num_frequency_blocks=1, couple_input_forget_gates=False, backward_slice_offset=0)` {#BidirectionalGridLSTMCell.__init__}
#### `tf.contrib.rnn.BidirectionalGridLSTMCell.__init__(num_units, use_peepholes=False, share_time_frequency_weights=False, cell_clip=None, initializer=None, num_unit_shards=1, forget_bias=1.0, feature_size=None, frequency_skip=None, num_frequency_blocks=None, start_freqindex_list=None, end_freqindex_list=None, couple_input_forget_gates=False, backward_slice_offset=0)` {#BidirectionalGridLSTMCell.__init__}
Initialize the parameters for an LSTM cell.
......@@ -879,8 +889,13 @@ Initialize the parameters for an LSTM cell.
the LSTM spans over.
* <b>`frequency_skip`</b>: (optional) int, default None, The amount the LSTM filter
is shifted by in frequency.
* <b>`num_frequency_blocks`</b>: (optional) int, default 1, The total number of
frequency blocks needed to cover the whole input feature.
* <b>`num_frequency_blocks`</b>: [required] A list of frequency blocks needed to
cover the whole input feature splitting defined by start_freqindex_list
and end_freqindex_list.
* <b>`start_freqindex_list`</b>: [optional], list of ints, default None, The
starting frequency index for each frequency block.
* <b>`end_freqindex_list`</b>: [optional], list of ints, default None. The ending
frequency index for each frequency block.
* <b>`couple_input_forget_gates`</b>: (optional) bool, default False, Whether to
couple the input and forget gates, i.e. f_gate = 1.0 - i_gate, to reduce
model parameters and computation cost.
......
......@@ -390,7 +390,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Bernoulli.parameters` {#Bernoulli.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -381,7 +381,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Chi2WithAbsDf.parameters` {#Chi2WithAbsDf.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -459,7 +459,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Dirichlet.parameters` {#Dirichlet.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -112,7 +112,7 @@ dist.mean().eval()
```
- - -
#### `tf.contrib.distributions.Distribution.__init__(dtype, parameters, is_continuous, is_reparameterized, validate_args, allow_nan_stats, name=None)` {#Distribution.__init__}
#### `tf.contrib.distributions.Distribution.__init__(dtype, is_continuous, is_reparameterized, validate_args, allow_nan_stats, parameters=None, graph_parents=None, name=None)` {#Distribution.__init__}
Constructs the `Distribution`.
......@@ -122,7 +122,6 @@ Constructs the `Distribution`.
* <b>`dtype`</b>: The type of the event samples. `None` implies no type-enforcement.
* <b>`parameters`</b>: Python dictionary of parameters used by this `Distribution`.
* <b>`is_continuous`</b>: Python boolean. If `True` this
`Distribution` is continuous over its supported domain.
* <b>`is_reparameterized`</b>: Python boolean. If `True` this
......@@ -136,7 +135,15 @@ Constructs the `Distribution`.
exception if a statistic (e.g., mean, mode) is undefined for any batch
member. If True, batch members with valid parameters leading to
undefined statistics will return `NaN` for this statistic.
* <b>`name`</b>: A name for this distribution (optional).
* <b>`parameters`</b>: Python dictionary of parameters used to instantiate this
`Distribution`.
* <b>`graph_parents`</b>: Python list of graph prerequisites of this `Distribution`.
* <b>`name`</b>: A name for this distribution. Default: subclass name.
##### Raises:
* <b>`ValueError`</b>: if any member of graph_parents is `None` or not a `Tensor`.
- - -
......@@ -476,7 +483,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Distribution.parameters` {#Distribution.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -443,7 +443,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.MultivariateNormalCholesky.parameters` {#MultivariateNormalCholesky.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -36,7 +36,7 @@ Run one step of LSTM.
- - -
#### `tf.contrib.rnn.BidirectionalGridLSTMCell.__init__(num_units, use_peepholes=False, share_time_frequency_weights=False, cell_clip=None, initializer=None, num_unit_shards=1, forget_bias=1.0, feature_size=None, frequency_skip=None, num_frequency_blocks=1, couple_input_forget_gates=False, backward_slice_offset=0)` {#BidirectionalGridLSTMCell.__init__}
#### `tf.contrib.rnn.BidirectionalGridLSTMCell.__init__(num_units, use_peepholes=False, share_time_frequency_weights=False, cell_clip=None, initializer=None, num_unit_shards=1, forget_bias=1.0, feature_size=None, frequency_skip=None, num_frequency_blocks=None, start_freqindex_list=None, end_freqindex_list=None, couple_input_forget_gates=False, backward_slice_offset=0)` {#BidirectionalGridLSTMCell.__init__}
Initialize the parameters for an LSTM cell.
......@@ -61,8 +61,13 @@ Initialize the parameters for an LSTM cell.
the LSTM spans over.
* <b>`frequency_skip`</b>: (optional) int, default None, The amount the LSTM filter
is shifted by in frequency.
* <b>`num_frequency_blocks`</b>: (optional) int, default 1, The total number of
frequency blocks needed to cover the whole input feature.
* <b>`num_frequency_blocks`</b>: [required] A list of frequency blocks needed to
cover the whole input feature splitting defined by start_freqindex_list
and end_freqindex_list.
* <b>`start_freqindex_list`</b>: [optional], list of ints, default None, The
starting frequency index for each frequency block.
* <b>`end_freqindex_list`</b>: [optional], list of ints, default None. The ending
frequency index for each frequency block.
* <b>`couple_input_forget_gates`</b>: (optional) bool, default False, Whether to
couple the input and forget gates, i.e. f_gate = 1.0 - i_gate, to reduce
model parameters and computation cost.
......
......@@ -442,7 +442,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.MultivariateNormalDiag.parameters` {#MultivariateNormalDiag.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -50,13 +50,13 @@ entropy are better done with samples or approximations, and are not
implemented by this class.
- - -
#### `tf.contrib.distributions.QuantizedDistribution.__init__(distribution, lower_cutoff=None, upper_cutoff=None, name='QuantizedDistribution')` {#QuantizedDistribution.__init__}
#### `tf.contrib.distributions.QuantizedDistribution.__init__(distribution, lower_cutoff=None, upper_cutoff=None, validate_args=False, name='QuantizedDistribution')` {#QuantizedDistribution.__init__}
Construct a Quantized Distribution representing `Y = ceiling(X)`.
Some properties are inherited from the distribution defining `X`.
In particular, `validate_args` and `allow_nan_stats` are determined for this
`QuantizedDistribution` by reading the `distribution`.
Some properties are inherited from the distribution defining `X`. Example:
`allow_nan_stats` is determined for this `QuantizedDistribution` by reading
the `distribution`.
##### Args:
......@@ -72,6 +72,9 @@ In particular, `validate_args` and `allow_nan_stats` are determined for this
If provided, base distribution's pdf/pmf should be defined at
`upper_cutoff - 1`.
`upper_cutoff` must be strictly greater than `lower_cutoff`.
* <b>`validate_args`</b>: Python boolean. Whether to validate input with asserts.
If `validate_args` is `False`, and the inputs are invalid,
correct behavior is not guaranteed.
* <b>`name`</b>: The name for the distribution.
##### Raises:
......@@ -498,7 +501,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.QuantizedDistribution.parameters` {#QuantizedDistribution.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -435,7 +435,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.StudentT.parameters` {#StudentT.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -102,7 +102,7 @@ normal = ds.TransformedDistribution(
```
- - -
#### `tf.contrib.distributions.TransformedDistribution.__init__(distribution, bijector, name=None)` {#TransformedDistribution.__init__}
#### `tf.contrib.distributions.TransformedDistribution.__init__(distribution, bijector, validate_args=False, name=None)` {#TransformedDistribution.__init__}
Construct a Transformed Distribution.
......@@ -113,6 +113,9 @@ Construct a Transformed Distribution.
instance of `Distribution`.
* <b>`bijector`</b>: The object responsible for calculating the transformation.
Typically an instance of `Bijector`.
* <b>`validate_args`</b>: Python boolean. Whether to validate input with asserts.
If `validate_args` is `False`, and the inputs are invalid,
correct behavior is not guaranteed.
* <b>`name`</b>: The name for the distribution. Default:
`bijector.name + distribution.name`.
......@@ -506,7 +509,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.TransformedDistribution.parameters` {#TransformedDistribution.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -44,7 +44,7 @@ Run one step of LSTM.
- - -
#### `tf.contrib.rnn.GridLSTMCell.__init__(num_units, use_peepholes=False, share_time_frequency_weights=False, cell_clip=None, initializer=None, num_unit_shards=1, forget_bias=1.0, feature_size=None, frequency_skip=None, num_frequency_blocks=1, couple_input_forget_gates=False, state_is_tuple=False)` {#GridLSTMCell.__init__}
#### `tf.contrib.rnn.GridLSTMCell.__init__(num_units, use_peepholes=False, share_time_frequency_weights=False, cell_clip=None, initializer=None, num_unit_shards=1, forget_bias=1.0, feature_size=None, frequency_skip=None, num_frequency_blocks=None, start_freqindex_list=None, end_freqindex_list=None, couple_input_forget_gates=False, state_is_tuple=False)` {#GridLSTMCell.__init__}
Initialize the parameters for an LSTM cell.
......@@ -69,8 +69,13 @@ Initialize the parameters for an LSTM cell.
the LSTM spans over.
* <b>`frequency_skip`</b>: (optional) int, default None, The amount the LSTM filter
is shifted by in frequency.
* <b>`num_frequency_blocks`</b>: (optional) int, default 1, The total number of
frequency blocks needed to cover the whole input feature.
* <b>`num_frequency_blocks`</b>: [required] A list of frequency blocks needed to
cover the whole input feature splitting defined by start_freqindex_list
and end_freqindex_list.
* <b>`start_freqindex_list`</b>: [optional], list of ints, default None, The
starting frequency index for each frequency block.
* <b>`end_freqindex_list`</b>: [optional], list of ints, default None. The ending
frequency index for each frequency block.
* <b>`couple_input_forget_gates`</b>: (optional) bool, default False, Whether to
couple the input and forget gates, i.e. f_gate = 1.0 - i_gate, to reduce
model parameters and computation cost.
......@@ -78,6 +83,11 @@ Initialize the parameters for an LSTM cell.
the `c_state` and `m_state`. By default (False), they are concatenated
along the column axis. This default behavior will soon be deprecated.
##### Raises:
* <b>`ValueError`</b>: if the num_frequency_blocks list is not specified
- - -
......
......@@ -426,7 +426,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Categorical.parameters` {#Categorical.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -403,7 +403,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Chi2.parameters` {#Chi2.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -399,7 +399,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Uniform.parameters` {#Uniform.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -457,7 +457,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.WishartCholesky.parameters` {#WishartCholesky.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -379,7 +379,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.BetaWithSoftplusAB.parameters` {#BetaWithSoftplusAB.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -469,7 +469,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Binomial.parameters` {#Binomial.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -478,7 +478,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.DirichletMultinomial.parameters` {#DirichletMultinomial.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -403,7 +403,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Exponential.parameters` {#Exponential.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -423,7 +423,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Gamma.parameters` {#Gamma.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -374,7 +374,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.GammaWithSoftplusAlphaBeta.parameters` {#GammaWithSoftplusAlphaBeta.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -423,7 +423,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.InverseGamma.parameters` {#InverseGamma.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -378,7 +378,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.InverseGammaWithSoftplusAlphaBeta.parameters` {#InverseGammaWithSoftplusAlphaBeta.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -477,7 +477,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Multinomial.parameters` {#Multinomial.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -469,7 +469,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.MultivariateNormalDiagPlusVDVT.parameters` {#MultivariateNormalDiagPlusVDVT.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -361,7 +361,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.BernoulliWithSigmoidP.parameters` {#BernoulliWithSigmoidP.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -468,7 +468,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Beta.parameters` {#Beta.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -383,7 +383,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Laplace.parameters` {#Laplace.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -350,7 +350,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.LaplaceWithSoftplusScale.parameters` {#LaplaceWithSoftplusScale.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -363,7 +363,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.StudentTWithAbsDfSoftplusSigma.parameters` {#StudentTWithAbsDfSoftplusSigma.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
### `tf.summary.scalar(name, tensor, summary_description=None, collections=None)` {#scalar}
### `tf.summary.scalar(name, tensor, collections=None)` {#scalar}
Outputs a `Summary` protocol buffer containing a single scalar value.
......@@ -9,8 +9,7 @@ The generated Summary has a Tensor.proto containing the input Tensor.
* <b>`name`</b>: A name for the generated node. Will also serve as the series name in
TensorBoard.
* <b>`tensor`</b>: A tensor containing a single floating point or integer value.
* <b>`summary_description`</b>: Optional summary_description_pb2.SummaryDescription
* <b>`tensor`</b>: A real numeric Tensor containing a single value.
* <b>`collections`</b>: Optional list of graph collections keys. The new summary op is
added to these collections. Defaults to `[GraphKeys.SUMMARIES]`.
......
......@@ -381,7 +381,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.ExponentialWithSoftplusLam.parameters` {#ExponentialWithSoftplusLam.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -434,7 +434,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.MultivariateNormalFull.parameters` {#MultivariateNormalFull.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -414,7 +414,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Normal.parameters` {#Normal.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -457,7 +457,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Mixture.parameters` {#Mixture.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -350,7 +350,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.NormalWithSoftplusSigma.parameters` {#NormalWithSoftplusSigma.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -373,7 +373,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.MultivariateNormalDiagWithSoftplusStDev.parameters` {#MultivariateNormalDiagWithSoftplusStDev.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -387,7 +387,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.Poisson.parameters` {#Poisson.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -453,7 +453,7 @@ param_shapes with static (i.e. TensorShape) shapes.
#### `tf.contrib.distributions.WishartFull.parameters` {#WishartFull.parameters}
Dictionary of parameters used by this `Distribution`.
Dictionary of parameters used to instantiate this `Distribution`.
- - -
......
......@@ -34,7 +34,7 @@ has one summary value containing the input tensor.
- - -
### `tf.summary.scalar(name, tensor, summary_description=None, collections=None)` {#scalar}
### `tf.summary.scalar(name, tensor, collections=None)` {#scalar}
Outputs a `Summary` protocol buffer containing a single scalar value.
......@@ -45,8 +45,7 @@ The generated Summary has a Tensor.proto containing the input Tensor.
* <b>`name`</b>: A name for the generated node. Will also serve as the series name in
TensorBoard.
* <b>`tensor`</b>: A tensor containing a single floating point or integer value.
* <b>`summary_description`</b>: Optional summary_description_pb2.SummaryDescription
* <b>`tensor`</b>: A real numeric Tensor containing a single value.
* <b>`collections`</b>: Optional list of graph collections keys. The new summary op is
added to these collections. Defaults to `[GraphKeys.SUMMARIES]`.
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册