Add TensorFlow documentation to the main class, and include examples on it. #867
Conversation
…he Microsoft.ML.Transforms namespace, and get picked up by the documentation
Removing the reference from the CsharpApi, since the transform is already created in the right namespace: Microsoft.ML.Transforms. Changing the visibility of the Summary, UserName and ShortName to internal.
…nce it will appear in the Microsoft.ML.Transforms namespace.
adding the <include> to the class post-merge.
| @@ -4,7 +4,7 @@ | |||
|
|
|||
| <member name="TensorflowTransform"> | |||
| <summary> | |||
| Extracts hidden layers' values from a pre-trained Tensorflow model. | |||
| Extracts hidden layers' values from a pre-trained Tensorflow model. | |||
There was a problem hiding this comment.
' [](start = 30, length = 6)
is it even necessary? #Pending
There was a problem hiding this comment.
XML requires to escap: ', ", <, >, & characters.
To my surprise, this was displaying fine, but i have had trouble with the rest of them. Changed it for consistency.
In reply to: 216144446 [](ancestors = 216144446)
src/Microsoft.ML/CSharpApi.cs
Outdated
| /// Transforms the data using the TensorFlow model. | ||
| /// </summary> | ||
| /// <include file='../Microsoft.ML.TensorFlow/doc.xml' path='doc/members/member[@name="TensorflowTransform"]/*' /> | ||
| /// <include file='../Microsoft.ML.TensorFlow/doc.xml' path='doc/members/example[@name="TensorflowTransform"]/*' /> |
There was a problem hiding this comment.
'doc/members/example [](start = 68, length = 20)
I see that example tag is under member tag. It's not immediately under members. Will it work?
My understanding is that if we are doing
/// <include file='../Microsoft.ML.TensorFlow/doc.xml' path='doc/members/member[@name="TensorflowTransform"]/*' />
Everything including example will also be copied here. #Resolved
There was a problem hiding this comment.
| }); | ||
|
|
||
| pipeline.Add(new ImageResizer(("ImageReal", "ImageCropped")) | ||
| pipeline.Add(new ImageResizer(("ImageReal", "ImageCropped")) |
There was a problem hiding this comment.
" [](start = 54, length = 1)
Turns out that " in the sections are ok, but not the <, > characters. Converted them to make the example more readable. #Resolved
ghost
locked as resolved and limited conversation to collaborators
Fixes #866
Adds the documentation to the class, and not just the Create method, and changes the visibility of some of the properties that don't need to be user-facing.
Includes the examples in the doc.