001/*
002 * Copyright (c) 2015-2020, Oracle and/or its affiliates. All rights reserved.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.tribuo.classification.explanations;
018
019import org.tribuo.Example;
020import org.tribuo.Model;
021import org.tribuo.Output;
022
023/**
024 * An explainer for text data. Hopefully uses a sensible sampling mechanism that understands text.
025 */
026public interface TextExplainer<T extends Output<T>> {
027
028    /**
029     * Converts the supplied text into an {@link Example}, and
030     * generates an explanation of the contained {@link Model}'s prediction.
031     * @param inputText The text to explain.
032     * @return An explanation of the prediction on this input text.
033     */
034    public Explanation<T> explain(String inputText);
035
036}