Skip to content
This repository was archived by the owner on Jul 10, 2025. It is now read-only.

Commit 227522b

Browse files
author
ematejska
authored
Merge pull request #199 from ematejska/update_rfc_template_example
Adding a link to Examples
2 parents 0839fa5 + 247b19f commit 227522b

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

rfcs/yyyymmdd-rfc-template.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,15 @@ Make sure you’ve thought through and addressed the following sections. If a se
5757
* Platforms: does this work on all platforms supported by TensorFlow? If not, why is that ok? Will it work on embedded/mobile? Does it impact automatic code generation or mobile stripping tooling? Will it work with transformation tools?
5858
* Execution environments (Cloud services, accelerator hardware): what impact do you expect and how will you confirm?
5959

60-
### Best Practices, Tutorials and Examples
60+
### Best Practices
6161
* Does this proposal change best practices for some aspect of using/developing TensorFlow? How will these changes be communicated/enforced?
62+
63+
### Tutorials and Examples
6264
* If design changes existing API or creates new ones, the design owner should create end-to-end examples (ideally, a tutorial) which reflects how new feature will be used. Some things to consider related to the tutorial:
6365
- The minimum requirements for this are to consider how this would be used in a Keras-based workflow, as well as a non-Keras (low-level) workflow. If either isn’t applicable, explain why.
64-
- It should show the usage of the new feature in an end to end example (from data reading to serving, if applicable). Many new features have unexpected effects in parts far away from the place of change that can be found by running through an end-to-end example.
65-
- This should be written as if it is documentation of the new feature, i.e., consumable by a user, not a TensorFlow developer. The code does not need to work (since feature is not implemented yet).
66+
- It should show the usage of the new feature in an end to end example (from data reading to serving, if applicable). Many new features have unexpected effects in parts far away from the place of change that can be found by running through an end-to-end example. TFX [Examples](https://github.com/tensorflow/tfx/tree/master/tfx/examples) have historically been good in identifying such unexpected side-effects and are as such one recommended path for testing things end-to-end.
67+
- This should be written as if it is documentation of the new feature, i.e., consumable by a user, not a TensorFlow developer.
68+
- The code does not need to work (since the feature is not implemented yet) but the expectation is that the code does work before the feature can be merged.
6669

6770
### Compatibility
6871
* Does the design conform to the backwards & forwards compatibility [requirements](https://www.tensorflow.org/programmers_guide/version_compat)?

0 commit comments

Comments
 (0)