smile.deep.activation.SoftShrink Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of smile-deep Show documentation

smile-deep

The newest version!

/*
 * Copyright (c) 2010-2024 Haifeng Li. All rights reserved.
 *
 * Smile is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Smile is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Smile.  If not, see .
 */

package smile.deep.activation;

import org.bytedeco.pytorch.Scalar;
import org.bytedeco.pytorch.global.torch;
import smile.deep.tensor.Tensor;

/**
 * Soft Shrink activation function.
 *
 * @author Haifeng Li
 */
public class SoftShrink extends ActivationFunction {
    /** The lambda value in the formulation. */
    final Scalar lambda;

    /** Constructor. */
    public SoftShrink() {
        this(0.5);
    }

    /**
     * Constructor.
     * @param lambda The lambda value in the formulation.
     */
    public SoftShrink(double lambda) {
        super(String.format("SoftShrink(%.4f)", lambda), false);
        if (lambda < 0.0) {
            throw new IllegalArgumentException("Invalid lambda: " + lambda);
        }
        this.lambda = new Scalar(lambda);
    }

    @Override
    public Tensor forward(Tensor x) {
        return new Tensor(torch.softshrink(x.asTorch(), lambda));
    }
}