org.nd4j.autodiff.samediff.internal.SessionMemMgr Maven / Gradle / Ivy
/*
* ******************************************************************************
* *
* *
* * 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.
* *
* * See the NOTICE file distributed with this work for additional
* * information regarding copyright ownership.
* * 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.autodiff.samediff.internal;
import org.nd4j.linalg.api.buffer.DataType;
import org.nd4j.linalg.api.ndarray.INDArray;
import org.nd4j.linalg.api.shape.LongShapeDescriptor;
import java.io.Closeable;
public interface SessionMemMgr extends Closeable {
/**
* Allocate an array with the specified datatype and shape.
* NOTE: This array should be assumed to be uninitialized - i.e., contains random values.
*
* @param detached If true: the array is safe to return outside of the SameDiff session run (for example, the array
* is one that may be returned to the user)
* @param dataType Datatype of the returned array
* @param shape Array shape
* @return The newly allocated (uninitialized) array
*/
INDArray allocate(boolean detached, DataType dataType, long... shape);
/**
* As per {@link #allocate(boolean, DataType, long...)} but from a LongShapeDescriptor instead
*/
INDArray allocate(boolean detached, LongShapeDescriptor descriptor);
/**
* Allocate an uninitialized array with the same datatype and shape as the specified array
*/
INDArray ulike(INDArray arr);
/**
* Duplicate the specified array, to an array that is managed/allocated by the session memory manager
*/
INDArray dup(INDArray arr);
/**
* Release the array. All arrays allocated via one of the allocate methods should be returned here once they are no
* longer used, and all references to them should be cleared.
* After calling release, anything could occur to the array - deallocated, workspace closed, reused, etc.
*
* @param array The array that can be released
*/
void release(INDArray array);
/**
* Close the session memory manager and clean up any memory / resources, if any
*/
void close();
}