33[ ![ Status] ( https://travis-ci.org/tensorflow/rust.svg?branch=master )] ( https://travis-ci.org/tensorflow/rust )
44
55TensorFlow Rust provides idiomatic [ Rust] ( https://www.rust-lang.org ) language
6- bindings for [ TensorFlow] ( http ://tensorflow.org) .
6+ bindings for [ TensorFlow] ( https ://www. tensorflow.org) .
77
88** Notice:** This project is still under active development and not guaranteed to have a
99stable API. This is especially true because the underlying TensorFlow C API has not yet
1010been stabilized as well.
1111
1212* [ Documentation] ( https://tensorflow.github.io/rust/tensorflow/ )
13- * [ TensorFlow website] ( http ://tensorflow.org)
13+ * [ TensorFlow website] ( https ://www. tensorflow.org)
1414* [ TensorFlow GitHub page] ( https://github.com/tensorflow/tensorflow )
1515
1616## Getting Started
@@ -45,11 +45,15 @@ and this to your crate root:
4545extern crate tensorflow;
4646```
4747
48- Then run ` cargo build -j 1 ` . Since TensorFlow is built during this process, and
49- the TensorFlow build is very memory intensive, we recommend using the ` -j 1 `
50- flag which tells cargo to use only one task, which in turn tells TensorFlow to
51- build with only one task. Of course, if you have a lot of RAM, you can use a
52- higher value.
48+ Then run ` cargo build -j 1 ` . The tensorflow-sys crate's
49+ [ ` build.rs ` ] ( https://github.com/tensorflow/rust/blob/f204b39/tensorflow-sys/build.rs#L44-L52 )
50+ now either downloads a pre-built, basic CPU only binary
51+ ([ the default] ( https://github.com/tensorflow/rust/pull/65 ) )
52+ or compiles TensorFlow if forced to by an environment variable. If TensorFlow
53+ is compiled during this process, since the full compilation is very memory
54+ intensive, we recommend using the ` -j 1 ` flag which tells cargo to use only one
55+ task, which in turn tells TensorFlow to build with only one task. Though, if
56+ you have a lot of RAM, you can obviously use a higher value.
5357
5458To include the especially unstable API (which is currently the ` expr ` module),
5559use ` --features tensorflow_unstable ` .
@@ -68,7 +72,7 @@ In short:
6872
69731 . Install [ SWIG] ( http://www.swig.org ) and [ NumPy] ( http://www.numpy.org ) . The
7074 version from your distro's package manager should be fine for these two.
71- 2 . [ Install Bazel] ( http ://bazel.io/docs/install.html) , which you may need to do
75+ 2 . [ Install Bazel] ( https ://bazel.io/docs/install.html) , which you may need to do
7276 from source.
73773 . ` git clone https://github.com/tensorflow/tensorflow `
74784 . ` cd tensorflow `
@@ -84,11 +88,8 @@ If this is not possible, add `$TENSORFLOW_SRC/bazel-bin/tensorflow` to
8488
8589You may need to run ` ldconfig ` to reset ` ld ` 's cache after copying ` libtensorflow.so ` .
8690
87- ** OSX Note** : If you are running on OSX, there is a
88- [ Homebrew PR] ( https://github.com/Homebrew/homebrew-core/pull/10273 ) in process which, once merged,
89- will make it easy to install ` libtensorflow ` wihout hassle. In the meantime, you can take a look at
90- [ snipsco/tensorflow-build] ( https://github.com/snipsco/tensorflow-build ) which provides a homebrew
91- tap that does essentially the same.
91+ ** macOS Note** : Via [ Homebrew] ( https://brew.sh/ ) , you can just run
92+ ` brew install libtensorflow ` .
9293
9394## FAQ's
9495
@@ -101,16 +102,16 @@ use. See http://doc.crates.io/manifest.html#the-features-section.
101102
102103## Contributing
103104Developers and users are welcome to join
104- [ #tensorflow-rust] ( http ://chat.mibbit.com/?server=irc.mozilla.org&channel=%23tensorflow-rust)
105+ [ #tensorflow-rust] ( https ://chat.mibbit.com/?server=irc.mozilla.org&channel=%23tensorflow-rust)
105106on irc.mozilla.org.
106107
107- See [ CONTRIBUTING.md ] ( CONTRIBUTING.md ) for information on how to contribute code.
108+ Please read the [ contribution guidelines ] ( CONTRIBUTING.md ) on how to contribute code.
108109
109110This is not an official Google product.
110111
111112RFCs are [ issues tagged with RFC] ( https://github.com/tensorflow/rust/labels/rfc ) .
112- Check them out and comment. Discussions are welcome . After all, thats what a Request For
113- Comment is for !
113+ Check them out and comment. Discussions are welcomed . After all, that is the purpose of
114+ Request For Comment !
114115
115116## License
116- This project is licensed under the terms of the [ Apache 2.0 license] ( https://github.com/tensorflow/rust/blob/master/ LICENSE) .
117+ This project is licensed under the terms of the [ Apache 2.0 license] ( LICENSE ) .
0 commit comments