org.tensorflow.op.data.LeakyReluGrad Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tensorflow Show documentation
The newest version!
/* Copyright 2018 The TensorFlow Authors. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
=======================================================================*/

// This class has been generated, DO NOT EDIT!

package org.tensorflow.op.data;

import org.tensorflow.Operand;
import org.tensorflow.Operation;
import org.tensorflow.OperationBuilder;
import org.tensorflow.Output;
import org.tensorflow.op.PrimitiveOp;
import org.tensorflow.op.Scope;

/**
 * Computes rectified linear gradients for a LeakyRelu operation.
 * 
 * @param  data type for {@code backprops()} output
 */
public final class LeakyReluGrad extends PrimitiveOp implements Operand {
  
  /**
   * Optional attributes for {@link org.tensorflow.op.data.LeakyReluGrad}
   */
  public static class Options {
    
    /**
     * @param alpha 
     */
    public Options alpha(Float alpha) {
      this.alpha = alpha;
      return this;
    }
    
    private Float alpha;
    
    private Options() {
    }
  }
  
  /**
   * Factory method to create a class wrapping a new LeakyReluGrad operation.
   * 
   * @param scope current scope
   * @param gradients The backpropagated gradients to the corresponding LeakyRelu operation.
   * @param features The features passed as input to the corresponding LeakyRelu operation,
   * OR the outputs of that operation (both work equivalently).
   * @param options carries optional attributes values
   * @return a new instance of LeakyReluGrad
   */
  public static  LeakyReluGrad create(Scope scope, Operand gradients, Operand features, Options... options) {
    OperationBuilder opBuilder = scope.env().opBuilder("LeakyReluGrad", scope.makeOpName("LeakyReluGrad"));
    opBuilder.addInput(gradients.asOutput());
    opBuilder.addInput(features.asOutput());
    opBuilder = scope.applyControlDependencies(opBuilder);
    if (options != null) {
      for (Options opts : options) {
        if (opts.alpha != null) {
          opBuilder.setAttr("alpha", opts.alpha);
        }
      }
    }
    return new LeakyReluGrad(opBuilder.build());
  }
  
  /**
   * @param alpha 
   */
  public static Options alpha(Float alpha) {
    return new Options().alpha(alpha);
  }
  
  /**
   * `gradients * (features > 0) + alpha * gradients * (features <= 0)`.
   */
  public Output backprops() {
    return backprops;
  }
  
  @Override
  public Output asOutput() {
    return backprops;
  }
  
  private Output backprops;
  
  private LeakyReluGrad(Operation operation) {
    super(operation);
    int outputIdx = 0;
    backprops = operation.output(outputIdx++);
  }
}