diff options
author | A. Unique TensorFlower <gardener@tensorflow.org> | 2016-07-19 08:24:41 -0800 |
---|---|---|
committer | TensorFlower Gardener <gardener@tensorflow.org> | 2016-07-19 09:34:11 -0700 |
commit | e728b00327934effec0bbae93caaf363165d0408 (patch) | |
tree | 1032fb52a774473210803a3bd940d314721c2990 /tensorflow/python | |
parent | 8309d010b3d4867392aec10fc31e4db09a165bf4 (diff) |
Adding API docs for tf.contrib.learn.monitors (also fixed a couple typos in
monitors.py docstrings).
Change: 127838930
Diffstat (limited to 'tensorflow/python')
-rw-r--r-- | tensorflow/python/framework/gen_docs_combined.py | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/tensorflow/python/framework/gen_docs_combined.py b/tensorflow/python/framework/gen_docs_combined.py index 06c2f23f0b..991423a0ec 100644 --- a/tensorflow/python/framework/gen_docs_combined.py +++ b/tensorflow/python/framework/gen_docs_combined.py @@ -61,6 +61,8 @@ def get_module_to_name(): tf.contrib.framework: "tf.contrib.framework", tf.contrib.layers: "tf.contrib.layers", tf.contrib.learn: "tf.contrib.learn", + tf.contrib.learn.monitors: ( + "tf.contrib.learn.monitors"), tf.contrib.losses: "tf.contrib.losses", tf.contrib.metrics: "tf.contrib.metrics", tf.contrib.util: "tf.contrib.util", @@ -164,6 +166,8 @@ def all_libraries(module_to_name, members, documented): library("contrib.framework", "Framework (contrib)", tf.contrib.framework), library("contrib.layers", "Layers (contrib)", tf.contrib.layers), library("contrib.learn", "Learn (contrib)", tf.contrib.learn), + library("contrib.learn.monitors", "Monitors (contrib)", + tf.contrib.learn.monitors), library("contrib.losses", "Losses (contrib)", tf.contrib.losses), library("contrib.metrics", "Metrics (contrib)", tf.contrib.metrics), library("contrib.util", "Utilities (contrib)", tf.contrib.util), @@ -180,6 +184,12 @@ _hidden_symbols = ["Event", "LogMessage", "Summary", "SessionLog", "xrange", "SaverDef", "VariableDef", "TestCase", "GrpcServer", "ClusterDef", "JobDef", "ServerDef"] +# TODO(skleinfeld, deannarubin) Address shortname +# conflict between tf.contrib.learn.NanLossDuringTrainingError and +# tf.contrib.learn.monitors.NanLossDuringTrainingError, arising due +# to imports in learn/python/learn/__init__.py +EXCLUDE = frozenset(["tf.contrib.learn.monitors.NanLossDuringTrainingError"]) + def main(unused_argv): if not FLAGS.out_dir: @@ -189,7 +199,7 @@ def main(unused_argv): # Document libraries documented = set() module_to_name = get_module_to_name() - members = docs.collect_members(module_to_name) + members = docs.collect_members(module_to_name, exclude=EXCLUDE) libraries = all_libraries(module_to_name, members, documented) # Define catch_all library before calling write_libraries to avoid complaining |