org.nd4j.linalg.learning.SgdUpdater Maven / Gradle / Ivy
/*
* ******************************************************************************
* *
* *
* * 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.
* *
* * See the NOTICE file distributed with this work for additional
* * information regarding copyright ownership.
* * 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.learning;
import lombok.Data;
import org.nd4j.common.base.Preconditions;
import org.nd4j.linalg.api.ndarray.INDArray;
import org.nd4j.linalg.factory.Nd4j;
import org.nd4j.linalg.learning.config.Sgd;
import java.util.Collections;
import java.util.Map;
/**
* SGD updater applies a learning rate only
* @author Adam Gibson
*/
@Data
public class SgdUpdater implements GradientUpdater {
private final Sgd config;
public SgdUpdater(Sgd config) {
this.config = config;
}
@Override
public void setState(Map stateMap, boolean initialize) {
Preconditions.checkState(stateMap == null || stateMap.isEmpty(), "SGD updater does not have any updater state," +
" attempting to set with %s values", (stateMap == null ? 0 : stateMap.size()));
}
@Override
public Map getState() {
return Collections.emptyMap();
}
@Override
public void setStateViewArray(INDArray viewArray, long[] gradientShape, char gradientOrder, boolean initialize) {
//No op
}
@Override
public void applyUpdater(INDArray gradient, int iteration, int epoch) {
double lr = config.getLearningRate(iteration, epoch);
Nd4j.exec(new org.nd4j.linalg.api.ops.impl.updaters.SgdUpdater(gradient, lr));
}
}