From 158ab051d6d778ef7bb5885dda7427176d443e67 Mon Sep 17 00:00:00 2001 From: Alan Yee Date: Mon, 21 Aug 2017 16:02:20 -0700 Subject: [PATCH 1/5] Update README.md -Update details -Made explicit HTTPS calls -Added a link to Homebrew --- README.md | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 084ffd913b..234ec8acac 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,14 @@ [![Status](https://travis-ci.org/tensorflow/rust.svg?branch=master)](https://travis-ci.org/tensorflow/rust) TensorFlow Rust provides idiomatic [Rust](https://www.rust-lang.org) language -bindings for [TensorFlow](http://tensorflow.org). +bindings for [TensorFlow](https://tensorflow.org). **Notice:** This project is still under active development and not guaranteed to have a stable API. This is especially true because the underlying TensorFlow C API has not yet been stabilized as well. * [Documentation](https://tensorflow.github.io/rust/tensorflow/) -* [TensorFlow website](http://tensorflow.org) +* [TensorFlow website](https://tensorflow.org) * [TensorFlow GitHub page](https://github.com/tensorflow/tensorflow) ## Getting Started @@ -68,7 +68,7 @@ In short: 1. Install [SWIG](http://www.swig.org) and [NumPy](http://www.numpy.org). The version from your distro's package manager should be fine for these two. -2. [Install Bazel](http://bazel.io/docs/install.html), which you may need to do +2. [Install Bazel](https://bazel.io/docs/install.html), which you may need to do from source. 3. `git clone https://github.com/tensorflow/tensorflow` 4. `cd tensorflow` @@ -84,11 +84,8 @@ If this is not possible, add `$TENSORFLOW_SRC/bazel-bin/tensorflow` to You may need to run `ldconfig` to reset `ld`'s cache after copying `libtensorflow.so`. -**OSX Note**: If you are running on OSX, there is a -[Homebrew PR](https://github.com/Homebrew/homebrew-core/pull/10273) in process which, once merged, -will make it easy to install `libtensorflow` wihout hassle. In the meantime, you can take a look at -[snipsco/tensorflow-build](https://github.com/snipsco/tensorflow-build) which provides a homebrew -tap that does essentially the same. +**macOS Note**: Via [Homebrew](https://brew.sh/) in process which, you can just run +`brew install libtensorflow`. ## FAQ's @@ -101,16 +98,16 @@ use. See http://doc.crates.io/manifest.html#the-features-section. ## Contributing Developers and users are welcome to join -[#tensorflow-rust](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23tensorflow-rust) +[#tensorflow-rust](https://chat.mibbit.com/?server=irc.mozilla.org&channel=%23tensorflow-rust) on irc.mozilla.org. -See [CONTRIBUTING.md](CONTRIBUTING.md) for information on how to contribute code. +Please read the [contribution guidelines](CONTRIBUTING.md) on how to contribute code. This is not an official Google product. RFCs are [issues tagged with RFC](https://github.com/tensorflow/rust/labels/rfc). -Check them out and comment. Discussions are welcome. After all, thats what a Request For -Comment is for! +Check them out and comment. Discussions are welcomed. After all, that is the purpose of +Request For Comment! ## License -This project is licensed under the terms of the [Apache 2.0 license](https://github.com/tensorflow/rust/blob/master/LICENSE). +This project is licensed under the terms of the [Apache 2.0 license](LICENSE). From 1130da1cc4abda35d54fb5df2f16e62afabeca58 Mon Sep 17 00:00:00 2001 From: Alan Yee Date: Wed, 23 Aug 2017 20:18:12 -0700 Subject: [PATCH 2/5] Update README.md Add www --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 234ec8acac..270d3669e6 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Status](https://travis-ci.org/tensorflow/rust.svg?branch=master)](https://travis-ci.org/tensorflow/rust) TensorFlow Rust provides idiomatic [Rust](https://www.rust-lang.org) language -bindings for [TensorFlow](https://tensorflow.org). +bindings for [TensorFlow](https://www.tensorflow.org). **Notice:** This project is still under active development and not guaranteed to have a stable API. This is especially true because the underlying TensorFlow C API has not yet From 34ba6f43c002ceb25cc819e2a1c549c07335d349 Mon Sep 17 00:00:00 2001 From: Alan Yee Date: Wed, 23 Aug 2017 20:27:25 -0700 Subject: [PATCH 3/5] Update README.md Add www --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 270d3669e6..4deb04f184 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ stable API. This is especially true because the underlying TensorFlow C API has been stabilized as well. * [Documentation](https://tensorflow.github.io/rust/tensorflow/) -* [TensorFlow website](https://tensorflow.org) +* [TensorFlow website](https://www.tensorflow.org) * [TensorFlow GitHub page](https://github.com/tensorflow/tensorflow) ## Getting Started From 9e726b1f14ee500e680dcaf34bc7650710f147b0 Mon Sep 17 00:00:00 2001 From: Alan Yee Date: Wed, 23 Aug 2017 20:36:23 -0700 Subject: [PATCH 4/5] Update README.md Remove unnecessary words --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4deb04f184..28b6dc5f2f 100644 --- a/README.md +++ b/README.md @@ -84,7 +84,7 @@ If this is not possible, add `$TENSORFLOW_SRC/bazel-bin/tensorflow` to You may need to run `ldconfig` to reset `ld`'s cache after copying `libtensorflow.so`. -**macOS Note**: Via [Homebrew](https://brew.sh/) in process which, you can just run +**macOS Note**: Via [Homebrew](https://brew.sh/), you can just run `brew install libtensorflow`. ## FAQ's From d355958e266828b768e0f0e0c60afc819393db28 Mon Sep 17 00:00:00 2001 From: Alan Yee Date: Thu, 24 Aug 2017 09:44:25 -0700 Subject: [PATCH 5/5] Update README.md Update usage --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 28b6dc5f2f..9aa82498cb 100644 --- a/README.md +++ b/README.md @@ -45,11 +45,15 @@ and this to your crate root: extern crate tensorflow; ``` -Then run `cargo build -j 1`. Since TensorFlow is built during this process, and -the TensorFlow build is very memory intensive, we recommend using the `-j 1` -flag which tells cargo to use only one task, which in turn tells TensorFlow to -build with only one task. Of course, if you have a lot of RAM, you can use a -higher value. +Then run `cargo build -j 1`. The tensorflow-sys crate's +[`build.rs`](https://github.com/tensorflow/rust/blob/f204b39/tensorflow-sys/build.rs#L44-L52) +now either downloads a pre-built, basic CPU only binary +([the default](https://github.com/tensorflow/rust/pull/65)) +or compiles TensorFlow if forced to by an environment variable. If TensorFlow +is compiled during this process, since the full compilation is very memory +intensive, we recommend using the `-j 1` flag which tells cargo to use only one +task, which in turn tells TensorFlow to build with only one task. Though, if +you have a lot of RAM, you can obviously use a higher value. To include the especially unstable API (which is currently the `expr` module), use `--features tensorflow_unstable`.