org.deeplearning4j.models.sequencevectors.listeners.SimilarityListener 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.deeplearning4j.models.sequencevectors.listeners;

import org.deeplearning4j.models.sequencevectors.SequenceVectors;
import org.deeplearning4j.models.sequencevectors.enums.ListenerEvent;
import org.deeplearning4j.models.sequencevectors.interfaces.VectorsListener;
import org.deeplearning4j.models.sequencevectors.sequence.SequenceElement;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.concurrent.atomic.AtomicLong;

/**
 * Simple listener, to monitor similarity between selected elements during training
 *
 * @author [email protected]
 */
public class SimilarityListener implements VectorsListener {
    protected static final Logger logger = LoggerFactory.getLogger(SimilarityListener.class);
    private final ListenerEvent targetEvent;
    private final int frequency;
    private final String element1;
    private final String element2;
    private final AtomicLong counter = new AtomicLong(0);

    public SimilarityListener(ListenerEvent targetEvent, int frequency, String label1, String label2) {
        this.targetEvent = targetEvent;
        this.frequency = frequency;
        this.element1 = label1;
        this.element2 = label2;
    }

    @Override
    public boolean validateEvent(ListenerEvent event, long argument) {
        return event == targetEvent;
    }

    @Override
    public void processEvent(ListenerEvent event, SequenceVectors sequenceVectors, long argument) {
        if (event != targetEvent)
            return;

        long cnt = counter.getAndIncrement();

        if (cnt % frequency != 0)
            return;

        double similarity = sequenceVectors.similarity(element1, element2);

        logger.info("Invocation: {}, similarity: {}", cnt, similarity);
    }
}