|
1 | | -<img src="https://swift.org/assets/images/swift.svg" alt="Swift logo" height="70" > |
2 | | - |
3 | | -# Swift Programming Language |
| 1 | +# Swift for TensorFlow |
4 | 2 |
|
| 3 | +| OS | CI platform | x86_64 | GPU | |
| 4 | +|---|:---:|:---:|:---:| |
| 5 | +| **macOS** | Google Kokoro |  | - | |
| 6 | +| **Ubuntu 16.04** | Swift.org CI | [](https://ci-external.swift.org/job/oss-swift-RA-linux-ubuntu-16.04-tensorflow) | [](https://ci-external.swift.org/job/oss-swift-RA-linux-ubuntu-16.04-tensorflow-gpu) | |
5 | 7 |
|
6 | 8 | | | **Architecture** | **Master** | **Package** | |
7 | 9 | |---|:---:|:---:|:---:| |
|
34 | 36 | |**[macOS 10.13](https://github.com/apple/swift-community-hosted-continuous-integration/blob/master/nodes/x86_64_macos_high_sierra_tensorflow.json)** | x86_64 |[](https://ci-external.swift.org/job/oss-swift-RA-macOS-tensorflow)| |
35 | 37 | |**[Ubuntu 16.04 (GPU)](https://github.com/apple/swift-community-hosted-continuous-integration/blob/master/nodes/x86_64_ubuntu_16_04_tensorflow_gpu.json)** | x86_64 |[](https://ci-external.swift.org/job/oss-swift-RA-linux-ubuntu-16.04-tensorflow-gpu)| |
36 | 38 |
|
| 39 | +<!-- SWIFT_ENABLE_TENSORFLOW --> |
| 40 | + |
| 41 | +Swift for TensorFlow is a new programming language for TensorFlow. It is a copy of the compiler for the [Swift Programming Language](https://swift.org) that adds first-class compiler and language support for machine learning. |
| 42 | + |
| 43 | +This repository covers the compiler and standard libraries. Please visit the [documentation repository](https://github.com/tensorflow/swift) for more information about the project, including a project overview, technical details, and guidelines for contributing. To use Swift for TensorFlow out of the box, follow the [installation instructions](https://github.com/tensorflow/swift/blob/master/Installation.md). To build from source, follow the instructions below. |
| 44 | +<!-- SWIFT_ENABLE_TENSORFLOW END --> |
| 45 | + |
37 | 46 | ## Welcome to Swift |
38 | 47 |
|
39 | 48 | Swift is a high-performance system programming language. It has a clean |
@@ -82,37 +91,36 @@ If you are interested in: |
82 | 91 |
|
83 | 92 | [Getting Started guide]: /docs/HowToGuides/GettingStarted.md |
84 | 93 |
|
85 | | -### Swift Toolchains |
| 94 | +### Swift For TensorFlow Toolchains |
86 | 95 |
|
87 | 96 | #### Building |
88 | 97 |
|
89 | | -Swift toolchains are created using the script |
90 | | -[build-toolchain](https://github.com/apple/swift/blob/master/utils/build-toolchain). This |
91 | | -script is used by swift.org's CI to produce snapshots and can allow for one to |
| 98 | +Swift for TensorFlow toolchains are created using the script |
| 99 | +[build-toolchain-tensorflow](https://github.com/apple/swift/blob/tensorflow/utils/build-toolchain-tensorflow). |
| 100 | +This script is used by swift.org's CI to produce snapshots and can allow for one to |
92 | 101 | locally reproduce such builds for development or distribution purposes. A typical |
93 | 102 | invocation looks like the following: |
94 | 103 |
|
95 | 104 | ``` |
96 | | - $ ./swift/utils/build-toolchain $BUNDLE_PREFIX |
| 105 | + $ ./swift/utils/build-toolchain-tensorflow $BUNDLE_PREFIX |
97 | 106 | ``` |
98 | 107 |
|
99 | | -where ``$BUNDLE_PREFIX`` is a string that will be prepended to the build |
100 | | -date to give the bundle identifier of the toolchain's ``Info.plist``. For |
101 | | -instance, if ``$BUNDLE_PREFIX`` was ``com.example``, the toolchain |
102 | | -produced will have the bundle identifier ``com.example.YYYYMMDD``. It |
103 | | -will be created in the directory you run the script with a filename |
104 | | -of the form: ``swift-LOCAL-YYYY-MM-DD-a-osx.tar.gz``. |
| 108 | +where ``$BUNDLE_PREFIX`` is a string that will be prepended to the build |
| 109 | +date to give the bundle identifier of the toolchain's ``Info.plist``. For |
| 110 | +instance, if ``$BUNDLE_PREFIX`` was ``com.example``, the toolchain |
| 111 | +produced will have the bundle identifier ``com.example.YYYYMMDD``. It |
| 112 | +will be created in the directory you run the script with a filename |
| 113 | + of the form: ``swift-tensorflow-LOCAL-YYYY-MM-DD-a-osx.tar.gz``. |
105 | 114 |
|
106 | | -Beyond building the toolchain, ``build-toolchain`` also supports the |
107 | | -following (non-exhaustive) set of useful options:: |
| 115 | +Beyond building the toolchain, ``build-toolchain-tensorflow`` also supports the |
| 116 | +following (non-exhaustive) set of useful options: |
108 | 117 |
|
109 | 118 | - ``--dry-run``: Perform a dry run build. This is off by default. |
110 | 119 | - ``--test``: Test the toolchain after it has been compiled. This is off by default. |
111 | | -- ``--distcc``: Use distcc to speed up the build by distributing the c++ part of |
112 | | - the swift build. This is off by default. |
| 120 | +- ``--pkg`` (macOS only): Build a toolchain installer package (`.pkg`). This is off by default. |
113 | 121 |
|
114 | 122 | More options may be added over time. Please pass ``--help`` to |
115 | | -``build-toolchain`` to see the full set of options. |
| 123 | +``build-toolchain-tensorflow`` to see the full set of options. |
116 | 124 |
|
117 | 125 | #### Installing into Xcode |
118 | 126 |
|
|
0 commit comments