org.tensorflow.op.collective.BroadcastSend Maven / Gradle / Ivy
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.collective;
import org.tensorflow.Operand;
import org.tensorflow.Operation;
import org.tensorflow.OperationBuilder;
import org.tensorflow.Output;
import org.tensorflow.Shape;
import org.tensorflow.op.PrimitiveOp;
import org.tensorflow.op.Scope;
/**
* Broadcasts a tensor value to one or more other devices.
*
* @param data type for {@code data()} output
*/
public final class BroadcastSend extends PrimitiveOp implements Operand {
/**
* Optional attributes for {@link org.tensorflow.op.collective.BroadcastSend}
*/
public static class Options {
/**
* @param communicationHint
*/
public Options communicationHint(String communicationHint) {
this.communicationHint = communicationHint;
return this;
}
private String communicationHint;
private Options() {
}
}
/**
* Factory method to create a class wrapping a new BroadcastSend operation.
*
* @param scope current scope
* @param input
* @param groupSize
* @param groupKey
* @param instanceKey
* @param shape
* @param options carries optional attributes values
* @return a new instance of BroadcastSend
*/
public static BroadcastSend create(Scope scope, Operand input, Long groupSize, Long groupKey, Long instanceKey, Shape shape, Options... options) {
OperationBuilder opBuilder = scope.env().opBuilder("CollectiveBcastSend", scope.makeOpName("BroadcastSend"));
opBuilder.addInput(input.asOutput());
opBuilder = scope.applyControlDependencies(opBuilder);
opBuilder.setAttr("group_size", groupSize);
opBuilder.setAttr("group_key", groupKey);
opBuilder.setAttr("instance_key", instanceKey);
opBuilder.setAttr("shape", shape);
if (options != null) {
for (Options opts : options) {
if (opts.communicationHint != null) {
opBuilder.setAttr("communication_hint", opts.communicationHint);
}
}
}
return new BroadcastSend(opBuilder.build());
}
/**
* @param communicationHint
*/
public static Options communicationHint(String communicationHint) {
return new Options().communicationHint(communicationHint);
}
/**
*/
public Output data() {
return data;
}
@Override
public Output asOutput() {
return data;
}
private Output data;
private BroadcastSend(Operation operation) {
super(operation);
int outputIdx = 0;
data = operation.output(outputIdx++);
}
}