Adding initial F# example for docs/samples #3163

singlis · 2019-04-02T00:34:25Z

Adds initial FSharp example for the docs samples. This is the ApplyCustomWordEmbedding. It is an in-memory example that follows the C# example.
Adds the Microsoft.ML.Samples.FSharp project to hold the FSharp examples
Adds the FSharp examples directory structure
Updates the ApplyWordBedding with an code-fsharp tag so that it will link to the correct sample

References #3100

TomFinley · 2019-04-02T17:14:07Z

docs/samples/Microsoft.ML.Samples.FSharp/Dynamic/Transforms/Text/ApplyCustomWordEmbedding.fs

+open System.IO
+
+type TextData(value:string) = 
+    member val Text = value with get,set


, [](start = 36, length = 1)

Formatting?

zeahmed · 2019-04-02T17:14:08Z

docs/samples/Microsoft.ML.Samples.FSharp/Dynamic/Transforms/Text/ApplyCustomWordEmbedding.fs

+let Example = 
+    // Create a new ML context, for ML.NET operations. It can be used for exception tracking and logging, 
+    // as well as the source of randomness.
+    let mlContext = MLContext()     


[](start = 31, length = 5)

I see white spaces at the end here...

zeahmed

TomFinley · 2019-04-02T17:19:39Z

docs/samples/Microsoft.ML.Samples.FSharp/Microsoft.ML.FSharp.Samples.fsproj

+
+  <ItemGroup>
+    <Compile Include="Dynamic\Transforms\Text\ApplyCustomWordEmbedding.fs" />
+    <Compile Include="Program.fs" />


So, is this necessary? With .csproj you don't need to enumerate files, is it actualyl necesary for FSharp?

TomFinley · 2019-04-02T17:21:56Z

src/Microsoft.ML.Transforms/Text/TextCatalog.cs

@@ -151,6 +151,7 @@ public static class TextCatalog
        /// <format type="text/markdown">
        /// <![CDATA[
        /// [!code-csharp[ApplyWordEmbedding](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/Text/ApplyCustomWordEmbedding.cs)]
+        /// [!code-fsharp[ApplyWordEmbedding](~/../docs/samples/docs/samples/Microsoft.ML.Samples.FSharp/Dynamic/Transforms/Text/ApplyCustomWordEmbedding.fs)]


ApplyCustomWordEmbedding [](start = 129, length = 24)

What is our intention here? Certainly we are not going to practically write equivalent F# samples for everything. Having one or two isolated ones is probably fine, but is there some plans for something broader? Not saying this is necessarily the place for it, just wondering if we have a broader strategy.

shmoradims · 2019-04-02T19:19:47Z

docs/samples/Microsoft.ML.Samples.FSharp/Dynamic/Transforms/Text/ApplyCustomWordEmbedding.fs

+    //   Features: -1.0000 0.0000 -100.0000 0.0000 34.0000 -25.6667 1.0000 100.0000 20.0000
+
+
+


extra lines

shmoradims

shmoradims · 2019-04-02T19:22:58Z

Microsoft.ML.sln

@@ -274,6 +274,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Microsoft.ML.FastTree", "Mi
 		pkg\Microsoft.ML.FastTree\Microsoft.ML.FastTree.symbols.nupkgproj = pkg\Microsoft.ML.FastTree\Microsoft.ML.FastTree.symbols.nupkgproj
 	EndProjectSection
 EndProject
+Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "Microsoft.ML.FSharp.Samples", "docs\samples\Microsoft.ML.Samples.FSharp\Microsoft.ML.FSharp.Samples.fsproj", "{370CF53B-2C46-49CF-86AA-D9CC77940E9D}"


FSharp.Samples [](start = 66, length = 14)

why is the proj is "FSharp.Samples" and the folder name is "Samples.FSharp"? let's keep them consistent (i prefer the latter, so that both c# and f# samples folders show up together, one after the other)

kevmal · 2019-04-03T13:08:54Z

docs/samples/Microsoft.ML.Samples.FSharp/Dynamic/Transforms/Text/ApplyCustomWordEmbedding.fs

+    let predictionEngine = mlContext.Model.CreatePredictionEngine<TextData, TransformedTextData>(textTransformer)
+
+    // Call the prediction API to convert the text into embedding vector.
+    let data = new TextData("This is a great product. I would like to buy it again.");


drop the new. Typically new is only used when IDisposable is implemented

kevmal · 2019-04-03T13:13:05Z

docs/samples/Microsoft.ML.Samples.FSharp/Dynamic/Transforms/Text/ApplyCustomWordEmbedding.fs

+
+    new() = TransformedTextData("")
+
+let Example = 


I'd consider moving all of this file to Program.fs. However if the current project structure is maintained I would do

let example() = ...

Given it outputs to the console and how it's referenced in the main function.

kevmal · 2019-04-03T13:14:14Z

docs/samples/Microsoft.ML.Samples.FSharp/Program.fs

+
+[<EntryPoint>]
+let main argv =
+    ApplyCustomWordEmbeddings.Example


Inline with my comment above this would be

ApplyCustomWordEmbeddings.example()

kevmal · 2019-04-03T13:16:21Z

docs/samples/Microsoft.ML.Samples.FSharp/Dynamic/Transforms/Text/ApplyCustomWordEmbedding.fs

+    // Print the embedding vector.
+    Console.Write("Features: ");
+    for i = 0 to prediction.Features.Length - 1 do
+        Console.Write("{0:F4} ", prediction.Features.[i])


use of printf/printfn is more common then Console.Write/Console.WriteLine in F# code.

kevmal · 2019-04-03T13:19:17Z

docs/samples/Microsoft.ML.Samples.FSharp/Dynamic/Transforms/Text/ApplyCustomWordEmbedding.fs

+
+type TransformedTextData(value: string) = 
+    inherit TextData(value)
+    member val Features:float32 array = Array.empty with get, set


member val Features : float32 [] = Array.empty with get, set is the preferred type annotation for arrays

singlis · 2019-04-10T06:32:15Z

thank you for the comments - I will be creating an F# getting started guide instead of doing samples. Closing this pr as a result.

singlis added 3 commits April 1, 2019 17:26

Initial checkin

0108b25

Merge remote-tracking branch 'origin/master' into singlis/fsharp

5fae158

Updating fsharp reference for CustomWordEmbedding sample

68095dd

singlis self-assigned this Apr 2, 2019

singlis requested review from natke, shmoradims and zeahmed April 2, 2019 00:34

singlis changed the title ~~Singlis/fsharp~~ Adding initial F# example for docs/samples Apr 2, 2019

TomFinley reviewed Apr 2, 2019

View reviewed changes

zeahmed reviewed Apr 2, 2019

View reviewed changes

zeahmed approved these changes Apr 2, 2019

View reviewed changes

TomFinley reviewed Apr 2, 2019

View reviewed changes

shmoradims reviewed Apr 2, 2019

View reviewed changes

shmoradims approved these changes Apr 2, 2019

View reviewed changes

shmoradims reviewed Apr 2, 2019

View reviewed changes

kevmal reviewed Apr 3, 2019

View reviewed changes

singlis closed this Apr 10, 2019

ghost locked as resolved and limited conversation to collaborators Mar 23, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding initial F# example for docs/samples #3163

Adding initial F# example for docs/samples #3163

singlis commented Apr 2, 2019

TomFinley Apr 2, 2019

zeahmed Apr 2, 2019

zeahmed left a comment

TomFinley Apr 2, 2019

TomFinley Apr 2, 2019

shmoradims Apr 2, 2019

shmoradims left a comment

shmoradims Apr 2, 2019 •

edited

Loading

kevmal Apr 3, 2019

kevmal Apr 3, 2019

kevmal Apr 3, 2019

kevmal Apr 3, 2019

kevmal Apr 3, 2019

singlis commented Apr 10, 2019

		// Features: -1.0000 0.0000 -100.0000 0.0000 34.0000 -25.6667 1.0000 100.0000 20.0000

Adding initial F# example for docs/samples #3163

Adding initial F# example for docs/samples #3163

Conversation

singlis commented Apr 2, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zeahmed left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shmoradims left a comment

Choose a reason for hiding this comment

shmoradims Apr 2, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

singlis commented Apr 10, 2019

shmoradims Apr 2, 2019 •

edited

Loading