Browse Source

Fix CS1572 (XML comment has a param tag, but there is no parameter by that name)

tags/v0.20
Sam Harwell Haiping 5 years ago
parent
commit
cef6ec0019
15 changed files with 16 additions and 36 deletions
  1. +1
    -2
      Directory.Build.props
  2. +1
    -1
      src/TensorFlowNET.Core/APIs/tf.init.cs
  3. +2
    -2
      src/TensorFlowNET.Core/Eager/c_api.eager.cs
  4. +2
    -3
      src/TensorFlowNET.Core/Gradients/nn_grad.cs
  5. +0
    -1
      src/TensorFlowNET.Core/Interfaces/ITensorFlowObject.cs
  6. +1
    -9
      src/TensorFlowNET.Core/Operations/NnOps/gen_nn_ops.cs
  7. +1
    -1
      src/TensorFlowNET.Core/Operations/control_flow_ops.cs
  8. +1
    -1
      src/TensorFlowNET.Core/Operations/random_ops.cs
  9. +1
    -1
      src/TensorFlowNET.Core/Operations/resource_variable_ops.cs
  10. +0
    -4
      src/TensorFlowNET.Core/Tensors/c_api.tensor.cs
  11. +1
    -1
      src/TensorFlowNET.Core/Tensors/constant_op.cs
  12. +2
    -1
      src/TensorFlowNET.Core/Training/GradientDescentOptimizer.cs
  13. +1
    -7
      src/TensorFlowNET.Core/Util/nest.py.cs
  14. +1
    -1
      src/TensorFlowNET.Core/Variables/gen_state_ops.py.cs
  15. +1
    -1
      src/TensorFlowNET.Core/ops.cs

+ 1
- 2
Directory.Build.props View File

@@ -17,9 +17,8 @@
Suppress warnings for currently-invalid documentation comments. Suppress warnings for currently-invalid documentation comments.


CS1570: XML comment has badly formed XML CS1570: XML comment has badly formed XML
CS1572: XML comment has a param tag, but there is no parameter by that name
--> -->
<NoWarn>$(NoWarn),1570,1572</NoWarn>
<NoWarn>$(NoWarn),1570</NoWarn>
</PropertyGroup> </PropertyGroup>


</Project> </Project>

+ 1
- 1
src/TensorFlowNET.Core/APIs/tf.init.cs View File

@@ -68,7 +68,7 @@ namespace Tensorflow
/// </summary> /// </summary>
/// <param name="factor"></param> /// <param name="factor"></param>
/// <param name="mode"></param> /// <param name="mode"></param>
/// <param name="distribution"></param>
/// <param name="uniform"></param>
/// <param name="seed"></param> /// <param name="seed"></param>
/// <param name="dtype"></param> /// <param name="dtype"></param>
/// <returns></returns> /// <returns></returns>


+ 2
- 2
src/TensorFlowNET.Core/Eager/c_api.eager.cs View File

@@ -18,7 +18,7 @@ namespace Tensorflow
/// <param name="op_name"></param> /// <param name="op_name"></param>
/// <param name="op_inputs"></param> /// <param name="op_inputs"></param>
/// <param name="op_outputs"></param> /// <param name="op_outputs"></param>
/// <param name="num_attrs"></param>
/// <param name="attrs_string"></param>
/// <param name="output_grads">previous node ouput</param> /// <param name="output_grads">previous node ouput</param>
/// <param name="skip_input_indices"></param> /// <param name="skip_input_indices"></param>
/// <returns></returns> /// <returns></returns>
@@ -355,7 +355,7 @@ namespace Tensorflow
/// TFE_ExecutorWaitForAllPendingNodes before calling this API if you want to /// TFE_ExecutorWaitForAllPendingNodes before calling this API if you want to
/// make sure all nodes are finished. /// make sure all nodes are finished.
/// </summary> /// </summary>
/// <param name="e">TFE_Executor*</param>
/// <param name="executor">TFE_Executor*</param>
[DllImport(TensorFlowLibName)] [DllImport(TensorFlowLibName)]
public static extern void TFE_DeleteExecutor(IntPtr executor); public static extern void TFE_DeleteExecutor(IntPtr executor);




+ 2
- 3
src/TensorFlowNET.Core/Gradients/nn_grad.cs View File

@@ -30,7 +30,7 @@ namespace Tensorflow.Gradients
/// Return the gradients for the 2 inputs of bias_op. /// Return the gradients for the 2 inputs of bias_op.
/// </summary> /// </summary>
/// <param name="op"></param> /// <param name="op"></param>
/// <param name="grad"></param>
/// <param name="grads"></param>
/// <returns></returns> /// <returns></returns>
[RegisterGradient("BiasAdd")] [RegisterGradient("BiasAdd")]
public static Tensor[] _BiasAddGrad(Operation op, Tensor[] grads) public static Tensor[] _BiasAddGrad(Operation op, Tensor[] grads)
@@ -78,8 +78,7 @@ namespace Tensorflow.Gradients
/// Gradient function for SoftmaxCrossEntropyWithLogits. /// Gradient function for SoftmaxCrossEntropyWithLogits.
/// </summary> /// </summary>
/// <param name="op"></param> /// <param name="op"></param>
/// <param name="grad_loss"></param>
/// <param name="grad_grad"></param>
/// <param name="grads"></param>
/// <returns></returns> /// <returns></returns>
[RegisterGradient("SoftmaxCrossEntropyWithLogits")] [RegisterGradient("SoftmaxCrossEntropyWithLogits")]
public static Tensor[] _SoftmaxCrossEntropyWithLogitsGrad(Operation op, Tensor[] grads) public static Tensor[] _SoftmaxCrossEntropyWithLogitsGrad(Operation op, Tensor[] grads)


+ 0
- 1
src/TensorFlowNET.Core/Interfaces/ITensorFlowObject.cs View File

@@ -23,7 +23,6 @@ namespace Tensorflow
/// <summary> /// <summary>
/// Called when the instance is created. /// Called when the instance is created.
/// </summary> /// </summary>
/// <param name="args"></param>
void __init__(); void __init__();


void __enter__(); void __enter__();


+ 1
- 9
src/TensorFlowNET.Core/Operations/NnOps/gen_nn_ops.cs View File

@@ -161,15 +161,7 @@ namespace Tensorflow.Operations
/// <summary> /// <summary>
/// Gradient for batch normalization. /// Gradient for batch normalization.
/// </summary> /// </summary>
/// <param name="y_backprop"></param>
/// <param name="x"></param>
/// <param name="scale"></param>
/// <param name="reserve_space_1"></param>
/// <param name="reserve_space_2"></param>
/// <param name="epsilon"></param>
/// <param name="data_format"></param>
/// <param name="is_training"></param>
/// <param name="name"></param>
/// <param name="params"></param>
/// <returns></returns> /// <returns></returns>
public static Tensor[] fused_batch_norm_grad(FusedBatchNormParams @params) public static Tensor[] fused_batch_norm_grad(FusedBatchNormParams @params)
{ {


+ 1
- 1
src/TensorFlowNET.Core/Operations/control_flow_ops.cs View File

@@ -637,7 +637,7 @@ namespace Tensorflow
/// <param name="cond"></param> /// <param name="cond"></param>
/// <param name="body"></param> /// <param name="body"></param>
/// <param name="loop_vars"></param> /// <param name="loop_vars"></param>
/// <param name="i"></param>
/// <param name="shape_invariants"></param>
public static TItem while_loop<TItem>(Func<TItem, Tensor> cond, Func<TItem, TItem> body, TItem loop_vars, public static TItem while_loop<TItem>(Func<TItem, Tensor> cond, Func<TItem, TItem> body, TItem loop_vars,
TensorShape[] shape_invariants = null, TensorShape[] shape_invariants = null,
int parallel_iterations = 10, int parallel_iterations = 10,


+ 1
- 1
src/TensorFlowNET.Core/Operations/random_ops.cs View File

@@ -158,7 +158,7 @@ namespace Tensorflow
/// </summary> /// </summary>
/// <param name="logits"></param> /// <param name="logits"></param>
/// <param name="num_samples"></param> /// <param name="num_samples"></param>
/// <param name="output_dtype"></param>
/// <param name="dtype"></param>
/// <param name="seed"></param> /// <param name="seed"></param>
/// <returns></returns> /// <returns></returns>
private static Tensor multinomial_categorical_impl(Tensor logits, int num_samples, TF_DataType dtype = TF_DataType.DtInvalid, private static Tensor multinomial_categorical_impl(Tensor logits, int num_samples, TF_DataType dtype = TF_DataType.DtInvalid,


+ 1
- 1
src/TensorFlowNET.Core/Operations/resource_variable_ops.cs View File

@@ -151,7 +151,7 @@ namespace Tensorflow
/// Sets the shape inference result HandleData on tensor. /// Sets the shape inference result HandleData on tensor.
/// </summary> /// </summary>
/// <param name="handle"></param> /// <param name="handle"></param>
/// <param name="full_handle_data"></param>
/// <param name="handle_data"></param>
/// <param name="graph_mode"></param> /// <param name="graph_mode"></param>
private static void _set_handle_shapes_and_types(Tensor handle, HandleData handle_data, bool graph_mode) private static void _set_handle_shapes_and_types(Tensor handle, HandleData handle_data, bool graph_mode)
{ {


+ 0
- 4
src/TensorFlowNET.Core/Tensors/c_api.tensor.cs View File

@@ -103,8 +103,6 @@ namespace Tensorflow
/// <param name="num_dims"></param> /// <param name="num_dims"></param>
/// <param name="data"></param> /// <param name="data"></param>
/// <param name="len">num_bytes, ex: 6 * sizeof(float)</param> /// <param name="len">num_bytes, ex: 6 * sizeof(float)</param>
/// <param name="deallocator"></param>
/// <param name="deallocator_arg"></param>
[MethodImpl(MethodImplOptions.AggressiveInlining)] [MethodImpl(MethodImplOptions.AggressiveInlining)]
public static unsafe IntPtr TF_NewTensor(TF_DataType dataType, long[] dims, int num_dims, IntPtr data, ulong len) public static unsafe IntPtr TF_NewTensor(TF_DataType dataType, long[] dims, int num_dims, IntPtr data, ulong len)
{ {
@@ -118,8 +116,6 @@ namespace Tensorflow
/// <param name="num_dims"></param> /// <param name="num_dims"></param>
/// <param name="data"></param> /// <param name="data"></param>
/// <param name="len">num_bytes, ex: 6 * sizeof(float)</param> /// <param name="len">num_bytes, ex: 6 * sizeof(float)</param>
/// <param name="deallocator"></param>
/// <param name="deallocator_arg"></param>
[MethodImpl(MethodImplOptions.AggressiveInlining)] [MethodImpl(MethodImplOptions.AggressiveInlining)]
public static unsafe IntPtr TF_NewTensor(TF_DataType dataType, long[] dims, int num_dims, void* data, ulong len) public static unsafe IntPtr TF_NewTensor(TF_DataType dataType, long[] dims, int num_dims, void* data, ulong len)
{ {


+ 1
- 1
src/TensorFlowNET.Core/Tensors/constant_op.cs View File

@@ -35,13 +35,13 @@ namespace Tensorflow
/// <param name="dtype">The type of the elements of the resulting tensor.</param> /// <param name="dtype">The type of the elements of the resulting tensor.</param>
/// <param name="shape">Optional dimensions of resulting tensor.</param> /// <param name="shape">Optional dimensions of resulting tensor.</param>
/// <param name="name">Optional name for the tensor.</param> /// <param name="name">Optional name for the tensor.</param>
/// <param name="verify_shape">Boolean that enables verification of a shape of values.</param>
/// <returns></returns> /// <returns></returns>
public static Tensor constant(object value, TF_DataType dtype = TF_DataType.DtInvalid, int[] shape = null, string name = "Const") public static Tensor constant(object value, TF_DataType dtype = TF_DataType.DtInvalid, int[] shape = null, string name = "Const")
{ {
return _constant_impl(value, dtype, shape, name, verify_shape: false, allow_broadcast: true); return _constant_impl(value, dtype, shape, name, verify_shape: false, allow_broadcast: true);
} }


/// <param name="verify_shape">Boolean that enables verification of a shape of values.</param>
public static Tensor _constant_impl(object value, public static Tensor _constant_impl(object value,
TF_DataType dtype, TF_DataType dtype,
TensorShape shape, TensorShape shape,


+ 2
- 1
src/TensorFlowNET.Core/Training/GradientDescentOptimizer.cs View File

@@ -21,6 +21,8 @@ namespace Tensorflow.Train
/// </summary> /// </summary>
public class GradientDescentOptimizer : Optimizer public class GradientDescentOptimizer : Optimizer
{ {
private bool _useTensor;

/// <summary> /// <summary>
/// Construct a new gradient descent optimizer. /// Construct a new gradient descent optimizer.
/// </summary> /// </summary>
@@ -35,7 +37,6 @@ namespace Tensorflow.Train
/// for changing these values across different invocations of optimizer /// for changing these values across different invocations of optimizer
/// functions. /// functions.
/// </remarks> /// </remarks>
private bool _useTensor;
public GradientDescentOptimizer(float learning_rate, bool use_locking = false, string name = "GradientDescent") public GradientDescentOptimizer(float learning_rate, bool use_locking = false, string name = "GradientDescent")
: base(learning_rate, use_locking, name) : base(learning_rate, use_locking, name)
{ {


+ 1
- 7
src/TensorFlowNET.Core/Util/nest.py.cs View File

@@ -486,13 +486,7 @@ namespace Tensorflow.Util
/// and the return value will contain the results in the same structure. /// and the return value will contain the results in the same structure.
/// </summary> /// </summary>
/// <param name="func"> A callable that accepts as many arguments as there are structures.</param> /// <param name="func"> A callable that accepts as many arguments as there are structures.</param>
/// <param name="structures">one or many IEnumerable of object</param>
/// <param name="check_types">If set to
/// `True` (default) the types of iterables within the structures have to be
/// same (e.g. `map_structure(func, [1], (1,))` raises a `TypeError`
/// exception). To allow this set this argument to `False`.
/// Note that namedtuples with identical name and fields are always
/// considered to have the same shallow structure.</param>
/// <param name="structure">one or many IEnumerable of object</param>
/// <returns> /// <returns>
/// A new structure with the same arity as `structure`, whose values correspond /// A new structure with the same arity as `structure`, whose values correspond
/// to `func(x[0], x[1], ...)` where `x[i]` is a value in the corresponding /// to `func(x[0], x[1], ...)` where `x[i]` is a value in the corresponding


+ 1
- 1
src/TensorFlowNET.Core/Variables/gen_state_ops.py.cs View File

@@ -51,7 +51,7 @@ namespace Tensorflow
/// <summary> /// <summary>
/// Update 'ref' by assigning 'value' to it /// Update 'ref' by assigning 'value' to it
/// </summary> /// </summary>
/// <param name="REF"></param>
/// <param name="ref"></param>
/// <param name="value"></param> /// <param name="value"></param>
/// <param name="validate_shape"></param> /// <param name="validate_shape"></param>
/// <param name="use_locking"></param> /// <param name="use_locking"></param>


+ 1
- 1
src/TensorFlowNET.Core/ops.cs View File

@@ -313,7 +313,7 @@ namespace Tensorflow
/// <summary> /// <summary>
/// Uses the default session to evaluate one or more tensors. /// Uses the default session to evaluate one or more tensors.
/// </summary> /// </summary>
/// <param name="tensors">A single Tensor, or a list of Tensor objects.</param>
/// <param name="tensor">A single Tensor, or a list of Tensor objects.</param>
/// <param name="feed_dict"> /// <param name="feed_dict">
/// A dictionary that maps Tensor objects (or tensor names) to lists, /// A dictionary that maps Tensor objects (or tensor names) to lists,
/// numpy ndarrays, TensorProtos, or strings. /// numpy ndarrays, TensorProtos, or strings.


Loading…
Cancel
Save