Skip to content
This repository has been archived by the owner on Feb 1, 2020. It is now read-only.

Latest commit

 

History

History
123 lines (82 loc) · 4.87 KB

README.md

File metadata and controls

123 lines (82 loc) · 4.87 KB
Raw

rust-cuBLAS

MIGRATED: SOURCE IS NOW PART OF THE JUICE REPOSITORY

Join the chat at https://gitter.im/spearow/coaster Build Status Crates.io License

rust-cuBLAS provides a safe wrapper for CUDA's cuBLAS library, so you can use cuBLAS comfortably and safely in your Rust application.

As cuBLAS currently relies on CUDA to allocate memory on the GPU, you might also look into rust-cuda.

rust-cublas was developed at Autumn for the Rust Machine Intelligence Framework Leaf.

rust-cublas is part of the High-Performance Computation Framework Collenchyma, for the BLAS Plugin. For an easy, unified interface for BLAS operations, such as those provided by cuBLAS, you might check out Collenchyma.

For more information,

Getting Started

If you're using Cargo, just add rust-cuBLAS to your Cargo.toml:

[dependencies]
cublas = "0.2.0"

If you're using Cargo Edit, you can call:

$ cargo add cublas

Building

The library can be built by entering cublas/ and cublas-sys/, and issuing a cargo build within each directory.

rust-cublas depends on the cuBLAS runtime libraries, which can be obtained from NVIDIA.

Manual Configuration

rust-cublas's build script will by default attempt to locate cublas via pkg-config. This will not work in some situations, for example,

  • on systems that don't have pkg-config,
  • when cross compiling, or
  • when cuBLAS is not installed in the default system library directory (e.g. /usr/lib).

Therefore the build script can be configured by exporting the following environment variables:

  • CUBLAS_LIB_DIR
    If specified, a directory that will be used to find cuBLAS runtime libraries. e.g. /opt/cuda/lib

  • CUBLAS_STATIC
    If specified, cuBLAS libraries will be statically rather than dynamically linked.

  • CUBLAS_LIBS
    If specified, will be used to find cuBLAS libraries under a different name.

If either CUBLAS_LIB_DIR or CUBLAS_INCLUDE_DIR are specified, then the build script will skip the pkg-config step.

If your also need to run the compiled binaries yourself, make sure that they are available:

# Linux; for other platforms consult the instructions that come with cuBLAS
cd <cublas_installpath>
export LD_LIBRARY_PATH=`pwd`:$LD_LIBRARY_PATH

Contributing

Want to contribute? Awesome! We have instructions to help you get started contributing code or documentation.

We have a mostly real-time collaboration culture and happens here on Github and on the Collenchyma Gitter Channel. You can also reach out to the Maintainers {@MJ, @hobofan}.

Changelog

You can find the release history in the root file CHANGELOG.md.

A changelog is a log or record of all the changes made to a project, such as a website or software project, usually including such records as bug fixes, new features, etc. - Wikipedia

We are using Clog, the Rust tool for auto-generating CHANGELOG files.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.