org.nd4j.linalg.cache.TADManager 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.nd4j.linalg.cache;
import org.nd4j.linalg.primitives.Pair;
import org.nd4j.linalg.api.buffer.DataBuffer;
import org.nd4j.linalg.api.ndarray.INDArray;
/**
* This interface describes TAD caching.
*
* While working with tensors, all operations are happening on some demensions,
* and since training tasks are repetitive, we can pre-calculate TAD shapes and offsets once,
* and reuse them later during whole training process.
*
*
*
* @author [email protected]
*/
public interface TADManager {
/**
* This method returns TAD shapeInfo and all offsets
* for specified tensor and dimensions.
*
* @param array Tensor for TAD precalculation
* @param dimension
* @return
*/
Pair getTADOnlyShapeInfo(INDArray array, int... dimension);
/**
* This method removes all cached shape buffers
*/
void purgeBuffers();
/**
* This method returns memory used for cache, in bytes
*
* @return
*/
long getCachedBytes();
}