smile.deep.CUDA Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of smile-deep Show documentation

smile-deep

The newest version!

/*
 * Copyright (c) 2010-2024 Haifeng Li. All rights reserved.
 *
 * Smile is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Smile is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Smile.  If not, see .
 */
package smile.deep;

import smile.deep.tensor.Device;
import org.bytedeco.pytorch.global.torch;

/**
 * NVIDIA CUDA helper functions.
 *
 * @author Haifeng Li
 */
public interface CUDA {
    /**
     * Returns true if CUDA is available.
     * @return true if CUDA is available.
     */
    static boolean isAvailable() {
        return torch.cuda_is_available();
    }

    /**
     * Returns the number of CUDA devices.
     * @return the number of CUDA devices.
     */
    static long deviceCount() {
        return torch.cuda_device_count();
    }

    /**
     * Returns the default CUDA device.
     *
     * @return the default CUDA device.
     */
    static Device device() {
        return Device.CUDA();
    }

    /**
     * Returns the CUDA device of given index.
     *
     * @param index the CUDA device index.
     * @return the CUDA device.
     */
    static Device device(byte index) {
        return Device.CUDA(index);
    }
}