com.simiacryptus.mindseye.test.unit.ComponentTest Maven / Gradle / Ivy

Go to download

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

Testing Tools for Neural Network 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.test.unit;

import com.simiacryptus.lang.ref.ReferenceCounting;
import com.simiacryptus.mindseye.lang.Layer;
import com.simiacryptus.mindseye.lang.Tensor;
import com.simiacryptus.notebook.NotebookOutput;

import javax.annotation.Nullable;

/**
 * The interface Derivative tester.
 *
 * @param  the type parameter
 */
public interface ComponentTest extends ReferenceCounting {
  /**
   * Test tolerance statistics.
   *
   * @param log            the log
   * @param component      the component
   * @param inputPrototype the input prototype
   * @return the tolerance statistics
   */
  @Nullable
  T test(NotebookOutput log, Layer component, Tensor... inputPrototype);

}