This repository contains models and examples written in Swift that use SwiftRT.

Swift Package Manager can be used to build CPU-only versions of the examples and tests. For CUDA capabilities, you'll need to build with CMake (see below). To build all targets within the project, use:

swift build

Unit tests can be run with

swift test

To run a specific example via Swift Package Manager, you can use the following:

swift run -c release Fractals [arguments]

CMake can build CUDA-capable models and examples, in addition to ones that run on the CPU. Currently, CMake 3.18 is required to build SwiftRT and these models. To build SwiftRT and models only with support for running on the local CPU, change to the project directory and use the following:

cmake -B build -D CMAKE_BUILD_TYPE=Release -D CMAKE_Swift_COMPILER=$(which swiftc) -G Ninja -S ./
cmake --build ./build

To enable CUDA, the SWIFTRT_ENABLE_CUDA option must be set to YES, and you may need to specify the target CUDA architecture or architectures you are targeting via CMAKE_CUDA_ARCHITECTURES. For example, the following targets CUDA compute capability 6.1 (GTX 10-series GPUs):

cmake -B build -D SWIFTRT_ENABLE_CUDA=YES -D CMAKE_CUDA_ARCHITECTURES="61" -D CMAKE_BUILD_TYPE=Release -D CMAKE_Swift_COMPILER=$(which swiftc) -G Ninja -S ./
cmake --build ./build

If you need to target more than one CUDA architecture, the values in CMAKE_CUDA_ARCHITECTURES can be separated by semicolons, such as "60;70;75".

The above will use the ./build directory to store the build configuration files and perform the build. Binaries for each model target can then be found within ./build/bin.

Please report model-related bugs and feature requests using GitHub issues in this repository.

Discussion about Swift for TensorFlow happens on the [email protected] mailing list.

We welcome contributions: please read the Contributor Guide to get started. It's always a good idea to discuss your plans on the mailing list before making any major submissions.

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

The Swift for TensorFlow community is guided by our Code of Conduct, which we encourage everybody to read before participating.