com.simiacryptus.mindseye.layers.StochasticComponent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mindseye-core Show documentation

Core Neural Networks Framework

There is a newer version: 2.1.0

/*
 * Copyright (c) 2018 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;

import com.simiacryptus.mindseye.lang.Layer;

import java.util.Random;

/**
 * A parent interface for layers which should be "shuffled" often, generally when the key has some random
 * noise-determining state. This is needed since even noise-introducing layers must behave well as analytic functions
 * between shuffles to guarantee the optimizer will converge.
 */
public interface StochasticComponent extends Layer {
  /**
   * The constant randomize.
   */
  ThreadLocal random = new ThreadLocal() {
    @Override
    protected Random initialValue() {
      return new Random();
    }
  };

  /**
   * Shuffle.
   *
   * @param seed the seed
   */
  void shuffle(final long seed);

  /**
   * Clear noise.
   */
  void clearNoise();
}