Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📚 Updated README with grammatical improvements ✍️ #2346

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

📚 Updated README with grammatical improvements ✍️ #2346

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 40 additions & 46 deletions site/en/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,50 +1,44 @@
# TensorFlow docs
# TensorFlow Documentation

These are the source files for the core TensorFlow
[guide](https://www.tensorflow.org/guide),
[tutorials](https://www.tensorflow.org/tutorials), and other technical docs.
Please read the
[contributor guide](https://www.tensorflow.org/community/contribute)
to submit patches to the TensorFlow documentation and code.
Welcome to the source files for the core TensorFlow documentation, including guides, tutorials, and other technical resources.

## TensorFlow ecosystem projects
To contribute to this documentation and codebase, please read the [Contributor Guide](https://www.tensorflow.org/community/contribute).

In addition to the core TensorFlow docs,
[tensorflow.org](https://www.tensorflow.org) hosts documentation for many
[libraries and extensions](https://www.tensorflow.org/resources/libraries-extensions).
These docs are sourced from separate project repos and where pull requests can
be sent. The following is a list of TensorFlow documentation projects published
on the website and a link to their source files:
## TensorFlow Ecosystem Projects

tensorflow.org project | GitHub docs location
-----------------------|---------------------
[/addons](https://www.tensorflow.org/addons) | https://github.com/tensorflow/addons/tree/master/docs
[/agents](https://www.tensorflow.org/agents) | https://github.com/tensorflow/agents/tree/master/docs
[/cloud](https://www.tensorflow.org/cloud) | https://github.com/tensorflow/cloud/tree/master/g3doc
[/datasets](https://www.tensorflow.org/datasets) | https://github.com/tensorflow/datasets/tree/master/docs
[/decision_forests](https://www.tensorflow.org/decision_forests) | https://github.com/tensorflow/decision-forests/tree/main/documentation
[/federated](https://www.tensorflow.org/federated) | https://github.com/tensorflow/federated/tree/main/docs
[/graphics](https://www.tensorflow.org/graphics) | https://github.com/tensorflow/graphics/tree/master/tensorflow_graphics/g3doc
[/hub](https://www.tensorflow.org/hub) | https://github.com/tensorflow/hub/tree/master/docs
[/io](https://www.tensorflow.org/io) | https://github.com/tensorflow/io/tree/master/docs/
[/js](https://www.tensorflow.org/js) | https://github.com/tensorflow/tfjs-website/tree/master/docs
[/jvm](https://www.tensorflow.org/jvm) | https://github.com/tensorflow/java/tree/master/docs
[/lattice](https://www.tensorflow.org/lattice) | https://github.com/tensorflow/lattice/tree/master/docs
[/lite](https://www.tensorflow.org/lite) | https://github.com/tensorflow/tensorflow/tree/master/tensorflow/lite/g3doc
[/mlir](https://www.tensorflow.org/mlir) | https://github.com/tensorflow/tensorflow/tree/master/tensorflow/compiler/mlir/g3doc
[/model_optimization](https://www.tensorflow.org/model_optimization) | https://github.com/tensorflow/model-optimization/tree/master/tensorflow_model_optimization/g3doc
[/neural_structured_learning](https://www.tensorflow.org/neural_structured_learning) | https://github.com/tensorflow/neural-structured-learning/tree/master/g3doc
[/probability](https://www.tensorflow.org/probability) | https://github.com/tensorflow/probability/tree/main/tensorflow_probability/g3doc
[/quantum](https://www.tensorflow.org/quantum) | https://github.com/tensorflow/quantum/tree/master/docs
[/ranking](https://www.tensorflow.org/ranking) | https://github.com/tensorflow/ranking/tree/master/docs
[/recommenders](https://www.tensorflow.org/recommenders) | https://github.com/tensorflow/recommenders/tree/main/docs
[/responsible_ai/fairness_indicators](https://www.tensorflow.org/responsible_ai/fairness_indicators/guide) | https://github.com/tensorflow/fairness-indicators/tree/master/g3doc
[/responsible_ai/model_card_toolkit](https://www.tensorflow.org/responsible_ai/model_card_toolkit/guide) | https://github.com/tensorflow/model-card-toolkit/tree/main/model_card_toolkit/documentation
[/responsible_ai/model_remediation](https://www.tensorflow.org/responsible_ai/model_remediation) | https://github.com/tensorflow/model-remediation/tree/master/docs
[/responsible_ai/privacy](https://www.tensorflow.org/responsible_ai/privacy/guide) | https://github.com/tensorflow/privacy/tree/master/g3doc
[/tensorboard](https://www.tensorflow.org/tensorboard) | https://github.com/tensorflow/tensorboard/tree/master/docs
[/guide/keras](https://www.tensorflow.org/guide/keras/) | https://github.com/keras-team/keras-io/tree/master/guides
[/text](https://www.tensorflow.org/text) | https://github.com/tensorflow/text/tree/master/docs
[/tfx](https://www.tensorflow.org/tfx) | https://github.com/tensorflow/tfx/tree/master/docs
[/tfx/guide/serving](https://www.tensorflow.org/tfx/guide/serving) | https://github.com/tensorflow/serving/tree/master/tensorflow_serving/g3doc
[/xla](https://www.tensorflow.org/xla) | https://github.com/tensorflow/tensorflow/tree/master/tensorflow/compiler/xla/g3doc
In addition to the core TensorFlow docs, the [TensorFlow website](https://www.tensorflow.org) hosts documentation for various libraries and extensions. These docs are sourced from individual project repositories, where pull requests can be submitted.

Here is a list of TensorFlow documentation projects hosted on the website along with links to their source files:

| TensorFlow Project | GitHub Docs Location |
|------------------------------|---------------------------------------------------------------------------|
| [Addons](https://www.tensorflow.org/addons) | [GitHub: tensorflow/addons](https://github.com/tensorflow/addons/tree/master/docs) |
| [Agents](https://www.tensorflow.org/agents) | [GitHub: tensorflow/agents](https://github.com/tensorflow/agents/tree/master/docs) |
| [Cloud](https://www.tensorflow.org/cloud) | [GitHub: tensorflow/cloud](https://github.com/tensorflow/cloud/tree/master/g3doc) |
| [Datasets](https://www.tensorflow.org/datasets) | [GitHub: tensorflow/datasets](https://github.com/tensorflow/datasets/tree/master/docs) |
| [Decision Forests](https://www.tensorflow.org/decision_forests) | [GitHub: tensorflow/decision-forests](https://github.com/tensorflow/decision-forests/tree/main/documentation) |
| [Federated](https://www.tensorflow.org/federated) | [GitHub: tensorflow/federated](https://github.com/tensorflow/federated/tree/main/docs) |
| [Graphics](https://www.tensorflow.org/graphics) | [GitHub: tensorflow/graphics](https://github.com/tensorflow/graphics/tree/master/tensorflow_graphics/g3doc) |
| [Hub](https://www.tensorflow.org/hub) | [GitHub: tensorflow/hub](https://github.com/tensorflow/hub/tree/master/docs) |
| [IO](https://www.tensorflow.org/io) | [GitHub: tensorflow/io](https://github.com/tensorflow/io/tree/master/docs/) |
| [JS](https://www.tensorflow.org/js) | [GitHub: tensorflow/tfjs-website](https://github.com/tensorflow/tfjs-website/tree/master/docs) |
| [JVM](https://www.tensorflow.org/jvm) | [GitHub: tensorflow/java](https://github.com/tensorflow/java/tree/master/docs) |
| [Lattice](https://www.tensorflow.org/lattice) | [GitHub: tensorflow/lattice](https://github.com/tensorflow/lattice/tree/master/docs) |
| [Lite](https://www.tensorflow.org/lite) | [GitHub: tensorflow/tensorflow](https://github.com/tensorflow/tensorflow/tree/master/tensorflow/lite/g3doc) |
| [MLIR](https://www.tensorflow.org/mlir) | [GitHub: tensorflow/tensorflow](https://github.com/tensorflow/tensorflow/tree/master/tensorflow/compiler/mlir/g3doc) |
| [Model Optimization](https://www.tensorflow.org/model_optimization) | [GitHub: tensorflow/model-optimization](https://github.com/tensorflow/model-optimization/tree/master/tensorflow_model_optimization/g3doc) |
| [Neural Structured Learning](https://www.tensorflow.org/neural_structured_learning) | [GitHub: tensorflow/neural-structured-learning](https://github.com/tensorflow/neural-structured-learning/tree/master/g3doc) |
| [Probability](https://www.tensorflow.org/probability) | [GitHub: tensorflow/probability](https://github.com/tensorflow/probability/tree/main/tensorflow_probability/g3doc) |
| [Quantum](https://www.tensorflow.org/quantum) | [GitHub: tensorflow/quantum](https://github.com/tensorflow/quantum/tree/master/docs) |
| [Ranking](https://www.tensorflow.org/ranking) | [GitHub: tensorflow/ranking](https://github.com/tensorflow/ranking/tree/master/docs) |
| [Recommenders](https://www.tensorflow.org/recommenders) | [GitHub: tensorflow/recommenders](https://github.com/tensorflow/recommenders/tree/main/docs) |
| [Responsible AI - Fairness Indicators](https://www.tensorflow.org/responsible_ai/fairness_indicators/guide) | [GitHub: tensorflow/fairness-indicators](https://github.com/tensorflow/fairness-indicators/tree/master/g3doc) |
| [Responsible AI - Model Card Toolkit](https://www.tensorflow.org/responsible_ai/model_card_toolkit/guide) | [GitHub: tensorflow/model-card-toolkit](https://github.com/tensorflow/model-card-toolkit/tree/main/model_card_toolkit/documentation) |
| [Responsible AI - Model Remediation](https://www.tensorflow.org/responsible_ai/model_remediation) | [GitHub: tensorflow/model-remediation](https://github.com/tensorflow/model-remediation/tree/master/docs) |
| [Responsible AI - Privacy](https://www.tensorflow.org/responsible_ai/privacy/guide) | [GitHub: tensorflow/privacy](https://github.com/tensorflow/privacy/tree/master/g3doc) |
| [TensorBoard](https://www.tensorflow.org/tensorboard) | [GitHub: tensorflow/tensorboard](https://github.com/tensorflow/tensorboard/tree/master/docs) |
| [Guide to Keras](https://www.tensorflow.org/guide/keras/) | [GitHub: keras-team/keras-io](https://github.com/keras-team/keras-io/tree/master/guides) |
| [Text](https://www.tensorflow.org/text) | [GitHub: tensorflow/text](https://github.com/tensorflow/text/tree/master/docs) |
| [TFX](https://www.tensorflow.org/tfx) | [GitHub: tensorflow/tfx](https://github.com/tensorflow/tfx/tree/master/docs) |
| [TFX Serving Guide](https://www.tensorflow.org/tfx/guide/serving) | [GitHub: tensorflow/serving](https://github.com/tensorflow/serving/tree/master/tensorflow_serving/g3doc) |
| [XLA](https://www.tensorflow.org/xla) | [GitHub: tensorflow/tensorflow](https://github.com/tensorflow/tensorflow/tree/master/tensorflow/compiler/xla/g3doc) |
8 changes: 1 addition & 7 deletions site/en/tutorials/text/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,7 @@ understand most of KerasNLP.

## TensorFlow Text

KerasNLP provides high-level text processing modules that are available as
layers or models. If you need access to lower-level tools, you can use
[TensorFlow Text](https://www.tensorflow.org/text/guide/tf_text_intro).
TensorFlow Text provides operations and libraries to help you work with raw text
strings and documents. TensorFlow Text can perform the preprocessing regularly
required by text-based models, and it also includes other features useful for
sequence modeling.
KerasNLP offers high-level text processing modules that are available as layers or models. If you require access to lower-level tools, you can use TensorFlow Text. TensorFlow Text provides a range of operations and libraries designed to work with raw text strings and documents. It handles the preprocessing commonly required by text-based models, and also includes additional features that are beneficial for sequence modeling.

Using TensorFlow Text, you can do the following:

Expand Down