diff options
| author |  Dan Moldovan <mdan@google.com> | 2018-07-11 15:21:24 -0700 |
|---|---|---|
| committer |  TensorFlower Gardener <gardener@tensorflow.org> | 2018-07-11 15:26:47 -0700 |
| commit | f2fa55c8d2f94bd186fc6c47b8ce00fb87c22aaf (patch) | |
| tree | af7c93124c7a8426f362e96e44d3a4d280777bbd | |
| parent | 3607217a7dc296baea06f190cfaa831f6b1471e6 (diff) | |
Add a few naming guidelines for the converter library.
PiperOrigin-RevId: 204199604
| -rw-r--r-- | tensorflow/contrib/autograph/converters/__init__.py | 14 |
1 files changed, 12 insertions, 2 deletions
diff --git a/tensorflow/contrib/autograph/converters/__init__.py b/tensorflow/contrib/autograph/converters/__init__.py index e4e8eda42f..6325ac78dc 100644 --- a/tensorflow/contrib/autograph/converters/__init__.py +++ b/tensorflow/contrib/autograph/converters/__init__.py @@ -18,5 +18,15 @@ from __future__ import absolute_import from __future__ import division from __future__ import print_function -# TODO(mdan): Define a base transformer class that can recognize skip_processing -# TODO(mdan): All converters are incomplete, especially those that change blocks +# Naming conventions: +# * each converter should specialize on a single idiom; be consistent with +# the Python reference for naming +# * all converters inherit core.converter.Base +# * module names describe the idiom that the converter covers, plural +# * the converter class is named consistent with the module, singular and +# includes the word Transformer +# +# Example: +# +# lists.py +# class ListTransformer(converter.Base) |