com.simiacryptus.mindseye.eval.TrainableDataMask 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.eval;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * A Trainable supplemental contract exposing a boolean mask which configures which, if any, input columns are to be
 * adjusted by the learning procedure. This can be used to trainCjGD per-row, non-shared parameters.
 */
public interface TrainableDataMask extends Trainable {
  /**
   * Get mask boolean [ ].
   *
   * @return the boolean [ ]
   */
  @Nullable
  boolean[] getMask();

  /**
   * Sets mask.
   *
   * @param mask the mask
   * @return the mask
   */
  @Nonnull
  TrainableDataMask setMask(boolean... mask);
}