com.simiacryptus.mindseye.layers.java.TargetValueLayer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mindseye-java Show documentation
Pure Java Neural Networks Components
There is a newer version: 2.1.0
/*
 * Copyright (c) 2019 by Andrew Charneski.
 *
 * The author licenses this file to you 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.
 */

package com.simiacryptus.mindseye.layers.java;

import com.google.gson.JsonObject;
import com.simiacryptus.mindseye.lang.DataSerializer;
import com.simiacryptus.mindseye.lang.Layer;
import com.simiacryptus.mindseye.lang.Tensor;
import com.simiacryptus.mindseye.layers.ValueLayer;
import com.simiacryptus.mindseye.network.DAGNetwork;
import com.simiacryptus.mindseye.network.DAGNode;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.annotation.Nonnull;
import java.util.Map;
import java.util.UUID;

/**
 * Works as a single-input terminal loss function which compares the input apply a preset constant target tensor.
 */
@SuppressWarnings("serial")
public class TargetValueLayer extends DAGNetwork {

  @SuppressWarnings("unused")
  private static final Logger log = LoggerFactory.getLogger(TargetValueLayer.class);
  private final DAGNode head;
  private final DAGNode target;

  /**
   * Instantiates a new Target value key.
   *
   * @param values the values
   */
  public TargetValueLayer(final double... values) {
    super(1);
    target = wrap(ValueLayer.wrap(new Tensor(values)));
    head = wrap(new MeanSqLossLayer(), getInput(0), target.addRef());
  }

  /**
   * Instantiates a new Target value key.
   *
   * @param json the json
   * @param rs   the rs
   */
  protected TargetValueLayer(@Nonnull final JsonObject json, Map rs) {
    super(json, rs);
    head = getNodeById(UUID.fromString(json.getAsJsonPrimitive("head").getAsString()));
    target = getNodeById(UUID.fromString(json.getAsJsonPrimitive("target").getAsString()));
  }

  /**
   * From json nn key.
   *
   * @param inner the heapCopy
   * @param rs    the rs
   * @return the nn key
   */
  public static Layer fromJson(@Nonnull final JsonObject inner, Map rs) {
    return new TargetValueLayer(inner, rs);
  }

  @Override
  protected void _free() {
    head.freeRef();
    target.freeRef();
    super._free();
  }

  @Override
  public DAGNode getHead() {
    head.addRef();
    return head;
  }

  @Override
  public JsonObject getJson(Map resources, DataSerializer dataSerializer) {
    final JsonObject json = super.getJson(resources, dataSerializer);
    json.addProperty("target", target.getId().toString());
    return json;
  }

  /**
   * Sets target.
   *
   * @param value the value
   * @return the target
   */
  @Nonnull
  public TargetValueLayer setTarget(final double... value) {
    target.getLayer().setData(new Tensor(value));
    return this;
  }
}