org.datavec.api.io.labels.PathLabelGenerator Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2015-2018 Skymind, Inc.
*
* 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.
*
* 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.datavec.api.io.labels;
import org.datavec.api.writable.Writable;
import java.io.Serializable;
import java.net.URI;
/**
* PathLabelGenerator: interface to infer the label of a file directly from the path of a file
* Example: /negative/file17.csv -> class "0"; /positive/file116.csv -> class "1" etc.
* Though note that the output is a writable, hence it need not be numerical.
*
* For use cases where multiple Writables are required (for example, networks with mixed classification/regression,
* or multiple output layers) use {@link PathMultiLabelGenerator} instead.
*
* @author Alex Black
* @see PathMultiLabelGenerator
*/
public interface PathLabelGenerator extends Serializable {
Writable getLabelForPath(String path);
Writable getLabelForPath(URI uri);
/**
* If true: infer the set of possible label classes, and convert these to integer indexes. If when true, the
* returned Writables should be text writables.
*
* For regression use cases (or PathLabelGenerator classification instances that do their own label -> integer
* assignment), this should return false.
*
* @return whether label classes should be inferred
*/
boolean inferLabelClasses();
}