Skip to content

Commit 0b5a2b2

Browse files
authored
Merge branch 'master' into master
2 parents 29246e9 + 4a37493 commit 0b5a2b2

File tree

187 files changed

+29231
-10647
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

187 files changed

+29231
-10647
lines changed

CODEOWNERS

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# https://help.github.com/articles/about-codeowners/
2-
# Last matching pattern takes preecedence.
2+
# Last matching pattern takes precedence.
33

44
# Default owners for everything in repo.
5-
* @lamberta @MarkDaoust @8bitmp3
5+
* @MarkDaoust @8bitmp3
66

77
# Docs
8-
/site/en/guide/keras/ @fchollet @lamberta @MarkDaoust @8bitmp3
8+
/site/en/guide/keras/ @fchollet @MarkDaoust @8bitmp3
99

1010
# Community
11-
/site/en/community/ @ewilderj @lamberta @theadactyl @joanafilipa
11+
/site/en/community/ @ewilderj @theadactyl @joanafilipa

MANIFEST.in

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
recursive-include tools/tensorflow_docs/api_generator/gen_java/ *
1+
recursive-include tools/tensorflow_docs/api_generator/gen_java/ *
2+
recursive-include tools/tensorflow_docs/api_generator/pretty_docs/templates/ *

OWNERS_METADATA

Lines changed: 0 additions & 20 deletions
This file was deleted.

setup.py

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,14 @@
2121
from setuptools import setup
2222

2323
project_name = 'tensorflow-docs'
24-
version = '0.0.0'
25-
26-
try:
27-
version += subprocess.check_output(['git', 'rev-parse',
28-
'HEAD']).decode('utf-8')
29-
except subprocess.CalledProcessError:
30-
pass
24+
version = '0.0.0.dev0'
3125

3226
DOCLINES = __doc__.split('\n')
3327

3428
REQUIRED_PKGS = [
3529
'astor',
3630
'absl-py',
31+
'jinja2',
3732
'protobuf>=3.14',
3833
'pyyaml',
3934
]

site/en/README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# TensorFlow docs
2+
3+
These are the source files for the core TensorFlow
4+
[guide](https://www.tensorflow.org/guide),
5+
[tutorials](https://www.tensorflow.org/tutorials), and other technical docs.
6+
Please read the
7+
[contributor guide](https://www.tensorflow.org/community/contribute)
8+
to submit patches to the TensorFlow documentation and code.
9+
10+
## TensorFlow ecosystem projects
11+
12+
In addition to the core TensorFlow docs,
13+
[tensorflow.org](https://www.tensorflow.org) hosts documentation for many
14+
[libraries and extensions](https://www.tensorflow.org/resources/libraries-extensions).
15+
These docs are sourced from separate project repos and where pull requests can
16+
be sent. The following is a list of TensorFlow documentation projects published
17+
on the website and a link to their source files:
18+
19+
tensorflow.org project | GitHub docs location
20+
-----------------------|---------------------
21+
[/addons](https://www.tensorflow.org/addons) | https://github.com/tensorflow/addons/tree/master/docs
22+
[/agents](https://www.tensorflow.org/agents) | https://github.com/tensorflow/agents/tree/master/docs
23+
[/cloud](https://www.tensorflow.org/cloud) | https://github.com/tensorflow/cloud/tree/master/g3doc
24+
[/datasets](https://www.tensorflow.org/datasets) | https://github.com/tensorflow/datasets/tree/master/docs
25+
[/decision_forests](https://www.tensorflow.org/decision_forests) | https://github.com/tensorflow/decision-forests/tree/main/documentation
26+
[/federated](https://www.tensorflow.org/federated) | https://github.com/tensorflow/federated/tree/main/docs
27+
[/graphics](https://www.tensorflow.org/graphics) | https://github.com/tensorflow/graphics/tree/master/tensorflow_graphics/g3doc
28+
[/hub](https://www.tensorflow.org/hub) | https://github.com/tensorflow/hub/tree/master/docs
29+
[/io](https://www.tensorflow.org/io) | https://github.com/tensorflow/io/tree/master/docs/
30+
[/js](https://www.tensorflow.org/js) | https://github.com/tensorflow/tfjs-website/tree/master/docs
31+
[/jvm](https://www.tensorflow.org/jvm) | https://github.com/tensorflow/java/tree/master/docs
32+
[/lattice](https://www.tensorflow.org/lattice) | https://github.com/tensorflow/lattice/tree/master/docs
33+
[/lite](https://www.tensorflow.org/lite) | https://github.com/tensorflow/tensorflow/tree/master/tensorflow/lite/g3doc
34+
[/mlir](https://www.tensorflow.org/mlir) | https://github.com/tensorflow/tensorflow/tree/master/tensorflow/compiler/mlir/g3doc
35+
[/model_optimization](https://www.tensorflow.org/model_optimization) | https://github.com/tensorflow/model-optimization/tree/master/tensorflow_model_optimization/g3doc
36+
[/neural_structured_learning](https://www.tensorflow.org/neural_structured_learning) | https://github.com/tensorflow/neural-structured-learning/tree/master/g3doc
37+
[/probability](https://www.tensorflow.org/probability) | https://github.com/tensorflow/probability/tree/main/tensorflow_probability/g3doc
38+
[/quantum](https://www.tensorflow.org/quantum) | https://github.com/tensorflow/quantum/tree/master/docs
39+
[/ranking](https://www.tensorflow.org/ranking) | https://github.com/tensorflow/ranking/tree/master/docs
40+
[/recommenders](https://www.tensorflow.org/recommenders) | https://github.com/tensorflow/recommenders/tree/main/docs
41+
[/responsible_ai/fairness_indicators](https://www.tensorflow.org/responsible_ai/fairness_indicators/guide) | https://github.com/tensorflow/fairness-indicators/tree/master/g3doc
42+
[/responsible_ai/model_card_toolkit](https://www.tensorflow.org/responsible_ai/model_card_toolkit/guide) | https://github.com/tensorflow/model-card-toolkit/tree/master/model_card_toolkit/documentation
43+
[/responsible_ai/model_remediation](https://www.tensorflow.org/responsible_ai/model_remediation) | https://github.com/tensorflow/model-remediation/tree/master/docs
44+
[/responsible_ai/privacy](https://www.tensorflow.org/responsible_ai/privacy/guide) | https://github.com/tensorflow/privacy/tree/master/g3doc
45+
[/tensorboard](https://www.tensorflow.org/tensorboard) | https://github.com/tensorflow/tensorboard/tree/master/docs
46+
[/guide/keras](https://www.tensorflow.org/guide/keras/) | https://github.com/keras-team/keras-io/tree/master/guides
47+
[/text](https://www.tensorflow.org/text) | https://github.com/tensorflow/text/tree/master/docs
48+
[/tfx](https://www.tensorflow.org/tfx) | https://github.com/tensorflow/tfx/tree/master/docs
49+
[/tfx/guide/serving](https://www.tensorflow.org/tfx/guide/serving) | https://github.com/tensorflow/serving/tree/master/tensorflow_serving/g3doc
50+
[/xla](https://www.tensorflow.org/xla) | https://github.com/tensorflow/tensorflow/tree/master/tensorflow/compiler/xla/g3doc

site/en/about/_menu_toc.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,3 @@ toc:
55
path: /about/
66
- label: "Case studies"
77
path: /about/case-studies/
8-
- label: "AI Service Partners"
9-
path: /partners/

site/en/addons/README.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

site/en/agents/README.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

site/en/community/contribute/docs.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,14 @@ To participate in the TensorFlow docs community:
2424

2525
* Watch the [tensorflow/docs](https://github.com/tensorflow/docs) GitHub
2626
repository.
27-
* Subscribe to [[email protected]](https://groups.google.com/a/tensorflow.org/forum/#!forum/docs).
27+
* Follow the [docs](https://discuss.tensorflow.org/tag/docs) tag on the
28+
[TensorFlow Forum](https://discuss.tensorflow.org/).
29+
2830

2931
## API reference
3032

31-
To update reference documentation, find the
33+
For details, use the [TensorFlow API docs contributor guide](docs_ref.md). This
34+
shows you how to find the
3235
[source file](https://www.tensorflow.org/code/tensorflow/python/)
3336
and edit the symbol's
3437
<a href="https://www.python.org/dev/peps/pep-0257/" class="external">docstring</a>.
@@ -38,9 +41,6 @@ where the symbol is defined. Docstrings support
3841
and can be (approximately) previewed using any
3942
<a href="http://tmpvar.com/markdown.html" class="external">Markdown previewer</a>.
4043

41-
For reference documentation quality and how to get involved with doc sprints and
42-
the community, see the
43-
[TensorFlow 2 API Docs advice](https://docs.google.com/document/d/1e20k9CuaZ_-hp25-sSd8E8qldxKPKQR-SkwojYr_r-U/preview).
4444

4545
### Versions and branches
4646

site/en/community/contribute/docs_ref.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@ def concat(values, axis, name="concat"):
4545

4646
Note: TensorFlow DocTest uses TensorFlow 2 and Python 3.
4747

48+
To assess reference documentation quality, see the example section of the
49+
[TensorFlow 2 API Docs advice](https://docs.google.com/document/d/1e20k9CuaZ_-hp25-sSd8E8qldxKPKQR-SkwojYr_r-U/preview).
50+
(Be aware that the Task Tracker on this sheet is no longer in use.)
51+
52+
4853
### Make the code testable with DocTest
4954

5055
Currently, many docstrings use backticks (```) to identify code. To make the

0 commit comments

Comments
 (0)