Skip to content

Commit eb87467

Browse files
authored
Updated documentation for TensorFlowTransform (#1077)
* updating documentation of TensorFlowTransform * making some some changes in the description
1 parent 5b4284c commit eb87467

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

src/Microsoft.ML.TensorFlow/doc.xml

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,34 +8,34 @@
88
</summary>
99
<remarks>
1010
<para>
11-
The TensorflowTransform extracts the specified outputs from the operations computed on the graph (given the input(s)) using a pre-trained <a href="https://www.tensorflow.org">Tensorflow</a> model.
12-
The transform takes as input the Tensorflow model together with the names of the inputs to the model and names of the operations for which output values will be extracted from the model.
11+
The TensorFlowTransform extracts specified outputs using a pre-trained <a href="https://www.tensorflow.org">Tensorflow</a> model.
12+
The transform takes as inputs the pre-trained Tensorflow model, the names of the input nodes, and names of the output nodes whose values we want to extract.
1313
</para>
1414

1515
<para>
16-
This transform requires the <a href="https://dotnet.myget.org/feed/dotnet-core/package/nuget/Microsoft.ML.TensorFlow/0.5.0-preview-26830-5">Microsoft.ML.TensorFlow</a> nuget to be installed.
17-
The TensorflowTransform has following assumptions regarding the input, output and processing of data.
16+
This transform requires the <a href="https://dotnet.myget.org/feed/dotnet-core/package/nuget/Microsoft.ML.TensorFlow">Microsoft.ML.TensorFlow</a> nuget to be installed.
17+
The TensorFlowTransform has the following assumptions regarding input, output and processing of data.
1818
</para>
1919
<list type="number">
2020
<item>
2121
<description>
22-
The transform currently accepts the <a href="https://www.tensorflow.org/mobile/prepare_models">frozen TensorFlow model</a> file as input.
22+
For the input model, currently the TensorFlowTransform supports both the <a href="https://www.tensorflow.org/mobile/prepare_models">Frozen model</a> format and also the <a href="https://www.tensorflow.org/guide/saved_model#build_and_load_a_savedmodel">SavedModel</a> format.
2323
</description>
2424
</item>
2525
<item>
2626
<description>The transform supports scoring only one example at a time.</description>
2727
</item>
2828
<item>
29-
<description>The name of input column(s) should match the name of input(s) in Tensorflow model.</description>
29+
<description>The name of input column(s) should match the name of input(s) in TensorFlow model.</description>
3030
</item>
3131
<item>
32-
<description>The name of each output column should match one of the operations in the Tensorflow graph.</description>
32+
<description>The name of each output column should match one of the operations in the TensorFlow graph.</description>
3333
</item>
3434
<item>
3535
<description>Currently, float and double are the only acceptable data types for input/output.</description>
3636
</item>
3737
<item>
38-
Upon success, the transform will introduce a new column in <see cref="IDataView"/> corresponding to each output column specified.
38+
<description>Upon success, the transform will introduce a new column in <see cref="IDataView"/> corresponding to each output column specified.</description>
3939
</item>
4040
</list>
4141

@@ -50,16 +50,16 @@
5050
pipeline.Add(new ColumnCopier(("NumericImageVec", "Input");
5151
pipeline.Add(new TensorFlowScorer()
5252
{
53-
ModelFile = model_location;
54-
InputColumns = new []{ "Input" };
55-
OutputColumns = "Output"
53+
Model = model_location;
54+
InputColumns = new[] { "Input" };
55+
OutputColumns = new[] { "Output" };
5656
}
5757
</code>
5858
</example>
5959
<example>
6060
<code language="csharp">
61-
var pipeline = new LearningPipeline(seed: 1);
62-
pipeline.Add(new TextLoader(dataFile).CreateFrom&lt;CifarData&gt;(useHeader: false));
61+
var pipeline = new Legacy.LearningPipeline(seed: 1);
62+
pipeline.Add(new Microsoft.ML.Legacy.Data.TextLoader(dataFile).CreateFrom&lt;CifarData&gt;(useHeader: false));
6363
pipeline.Add(new ImageLoader(("ImagePath", "ImageReal"))
6464
{
6565
ImageFolder = imageFolder
@@ -80,10 +80,11 @@
8080

8181
pipeline.Add(new TensorFlowScorer()
8282
{
83-
ModelFile = model_location,
83+
Model = model_location,
8484
InputColumns = new[] { "Input" },
85-
OutputColumns = "Output"
85+
OutputColumns = new[] { "Output" }
8686
});
87+
8788
</code>
8889
</example>
8990
</member>

0 commit comments

Comments
 (0)