org.nd4j.linalg.api.ops.impl.transforms.SoftMax Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2015-2018 Skymind, Inc.
*
* This program and the accompanying materials are made available under the
* terms of the Apache License, Version 2.0 which is available at
* https://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.
*
* SPDX-License-Identifier: Apache-2.0
******************************************************************************/
package org.nd4j.linalg.api.ops.impl.transforms;
import org.nd4j.autodiff.samediff.SDVariable;
import org.nd4j.autodiff.samediff.SameDiff;
import org.nd4j.linalg.api.ndarray.INDArray;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
/**
* Soft max function
* row_maxes is a row vector (max for each row)
* row_maxes = rowmaxes(input)
* diff = exp(input - max) / diff.rowSums()
* Outputs a probability distribution.
* Note that this is a parameterized model and requires
* the sum and max for the vector being calculated
*
* @author Adam Gibson
*/
public class SoftMax extends BaseDynamicTransformOp {
public SoftMax() {
super();
}
public SoftMax(SameDiff sameDiff, SDVariable[] args) {
super(sameDiff, args, false);
}
public SoftMax(SameDiff sameDiff, SDVariable[] args, boolean inPlace) {
super(sameDiff, args, inPlace);
}
public SoftMax(INDArray input, INDArray result){
super(new INDArray[]{input}, new INDArray[]{result});
}
@Override
public String opName() {
return "softmax";
}
@Override
public String onnxName() {
return "Softmax";
}
@Override
public String tensorflowName() {
return "Softmax";
}
@Override
public List doDiff(List i_v) {
SDVariable ret = f().softmaxDerivative(arg(), i_v.get(0), 1);
return Collections.singletonList(ret);
}
}