From eaf0f8c1dab91af10c3c63385e953dd2917c0da0 Mon Sep 17 00:00:00 2001
From: "A. Unique TensorFlower" <gardener@tensorflow.org>
Date: Thu, 5 Jan 2017 14:38:01 -0800
Subject: [PATCH] Clarify in comments what the source of truth is for a Node's
inputs. Change: 143710475
---
tensorflow/core/graph/graph.h | 13 +++++++++++--
1 file changed, 11 insertions(+), 2 deletions(-)
diff --git a/tensorflow/core/graph/graph.h b/tensorflow/core/graph/graph.h
index 7f4e365ca4f..24e38c6b1f9 100644
--- a/tensorflow/core/graph/graph.h
+++ b/tensorflow/core/graph/graph.h
@@ -70,6 +70,15 @@ class Node {
int cost_id() const { return cost_id_; }
const string& name() const { return props_->node_def_.name(); }
const string& type_string() const { return props_->node_def_.op(); }
+ // def() provides the NodeDef the user supplied, but the specifics
+ // of this Node may have changed due to placement, optimization, etc.
+ // In particular:
+ // * def().name() will match name();
+ // * def().op() will match type_string() and op_def().name();
+ // * def().input() is not reliable, use "in_edges()" below instead;
+ // * def().device() is the "user's requested device" and may not match
+ // the actual assigned device, see assigned_device_name() below;
+ // * def().attr() is authoritative.
const NodeDef& def() const { return props_->node_def_; }
const OpDef& op_def() const { return *props_->op_def_; }
@@ -86,8 +95,8 @@ class Node {
// you want the device the user requested, use def().device() instead.
// TODO(josh11b): Validate that the assigned_device, if not empty:
// fully specifies a device, and satisfies def().device().
- // TODO(josh11b): Move device_name outside of Node into a NodeId->DeviceName
- // map.
+ // TODO(josh11b): Move assigned_device_name outside of Node into a
+ // NodeId->DeviceName map.
string assigned_device_name() const { return assigned_device_name_; }
void set_assigned_device_name(const string& device_name) {
assigned_device_name_ = device_name;