aboutsummaryrefslogtreecommitdiffhomepage
path: root/tensorflow/contrib/README.md
diff options
context:
space:
mode:
authorGravatar A. Unique TensorFlower <nobody@tensorflow.org>2016-04-05 14:07:32 -0800
committerGravatar TensorFlower Gardener <gardener@tensorflow.org>2016-04-05 15:16:40 -0700
commite332d66464c5cabe53d4c7f5d8fc4ceb5d773b52 (patch)
tree561e77b449bb7a2de04f345c046fcc28cb242870 /tensorflow/contrib/README.md
parent9986acdaa49ee554ea11a6bdd7377a96a2a44922 (diff)
Add README.md files for some contrib packages.
Change: 119095651
Diffstat (limited to 'tensorflow/contrib/README.md')
-rw-r--r--tensorflow/contrib/README.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/tensorflow/contrib/README.md b/tensorflow/contrib/README.md
index e3c19b7ea2..914aea6492 100644
--- a/tensorflow/contrib/README.md
+++ b/tensorflow/contrib/README.md
@@ -4,10 +4,10 @@ Any code in this directory is not officially supported, and may change or be
removed at any time without notice.
The contrib directory contains project directories, each of which has designated
-owners. It is meant to contain features and contributions that eventually should
+owners. It is meant to contain features and contributions that eventually should
get merged into core TensorFlow, but whose interfaces may still change, or which
require some testing to see whether they can find broader acceptance. We are
-trying to keep dupliction within contrib to a minimum, so you may be asked to
+trying to keep dupliction within contrib to a minimum, so you may be asked to
refactor code in contrib to use some feature inside core or in another project
in contrib rather than reimplementing the feature.
@@ -15,9 +15,9 @@ When adding a project, please stick to the following directory structure:
Create a project directory in `contrib/`, and mirror the portions of the
TensorFlow tree that your project requires underneath `contrib/my_project/`.
-For example, let's say you create foo ops in two files: `foo_ops.py` and
-`foo_ops_test.py`. If you were to merge those files directly into TensorFlow,
-they would live in `tensorflow/python/ops/foo_ops.py` and
-`tensorflow/python/kernel_tests/foo_ops_test.py`. In `contrib/`, they are part
+For example, let's say you create foo ops in two files: `foo_ops.py` and
+`foo_ops_test.py`. If you were to merge those files directly into TensorFlow,
+they would live in `tensorflow/python/ops/foo_ops.py` and
+`tensorflow/python/kernel_tests/foo_ops_test.py`. In `contrib/`, they are part
of project `foo`, and their full paths are `contrib/foo/python/ops/foo_ops.py`
and `contrib/foo/python/kernel_tests/foo_ops_test.py`.