Glad to see you here! Now that you found out and learned about FsLab, this section aims to illustrate how FsLab packages synergize and can be used to tackle
practical data science challenges. Note that every package used througout the tutorial has its own documentation so if you are interested in Deedle (link), FSharp.Stats or Plotly.Net feel free to take a deeper dive.
FsLab is a meant to be a project incubation space and can be thought of as a safe heaven for both, package developers and package users by providing guidelines and tutorials. Packages provided by the community can be used on their own, in combination with other FsLab packages but also in combination with any other .netstandard 2.0 compatible package. From F# 5.0 on packages can be referenced using the following notation:
// Packages hosted by the Fslab community#r"nuget: Deedle"#r"nuget: FSharp.Stats"// third party .net packages #r"nuget: Plotly.NET, 2.0.0-preview.6"#r"nuget: Plotly.NET.Interactive, 2.0.0-preview.6"#r"nuget: FSharp.Data"
after referencing the packages one can access their namespaces and use provided functions. In the following example we will reference the
top level namespaces and then use a function provided by the FSharp.Stats package to calculate a factorial:
Equipped with these packages we are now ready to tackle promises made in the first paragraph: solving a practical data science problem. We will start by retrieving the data using the FSharp.Data package, subsequently we will use Deedle (link), a powerful data frame library that makes tabular data accessible by data frame programming. (Note that the chosen names give insight on their type, however thanks to FSharp being a strongly typed language and the we can at any time hower over single values to see the assigned type.)
openFSharp.DataopenDeedle// Retrieve data using the FSharp.Data packageletrawData=Http.RequestString@"https://raw.githubusercontent.com/dotnet/machinelearning/master/test/data/housing.txt"// Use .net Core functions to convert the retrieved string to a streamletdataAsStream=newSystem.IO.MemoryStream(rawData|>System.Text.Encoding.UTF8.GetBytes)// And finally create a data frame object using the ReadCsv method provided by Deedle.// Note: Of course you can directly provide the path to a local source.letdataAsFrame=Frame.ReadCsv(dataAsStream,hasHeaders=true,separators="\t")// Using the Print() method, we can use the Deedle pretty printer to have a look at the data set.dataAsFrame.Print()
The data set of choice is the boston housing data set. As you can see from analyzing the printed output, it consists of 506 rows. Each row represents a house in the boston city area and each column encodes a feature/variable, such as the number of rooms per dwelling (RoomsPerDwelling), Median value of owner-occupied homes in $1000's (MedianHomeValue) and even variables indicating if the house is bordering river charles (CharlesRiver, value = 1) or not (CharlesRiver, value = 0).
Lets say in our analysis we are only interested in the variables just described, furthermore we only want to keep rows where the value of the indicator variable is 0. We can use Deedle to easily create a new frame that fullfills our criteria. In this example we also cast the value of the column "CharlesRiver" to be of type bool, this illustrates how data frame programming can become typesafe using deedle.
lethousesNotAtRiver=dataAsFrame|>Frame.sliceCols["RoomsPerDwelling";"MedianHomeValue";"CharlesRiver"]|>Frame.filterRowValues(funs->s.GetAs<bool>("CharlesRiver")|>not)//sprintf "The new frame does now contain: %i rows and %i columns" housesNotAtRiver.RowCount housesNotAtRiver.ColumnCounthousesNotAtRiver.Print()
Exploratory data analysis is an approach favored by many - to meet this demand we strongly advertise the use of Plotly.Net. The following snippet illustrates how we can access a column of a data frame and create an interactive chart in no time. Since we might want an idea of the distribution of the house prices a histogram can come in handy:
openPlotly.NET// Note that we explicitly specify that we want to work with the values as floats. // Since the row identity is not needed anymore when plotting the distribution we can// directly convert the collection to a FSharp Sequence. letpricesNotAtRiver:seq<float>=housesNotAtRiver|>Frame.getCol"MedianHomeValue"|>Series.valuesleth1=Chart.Histogram(pricesNotAtRiver)|>Chart.withX_AxisStyle("median value of owner occupied homes in 1000s")|>Chart.withX_AxisStyle("price distribution")
Since plotly charts are interactive they invite us to combine mutliple charts. Let repeat the filter step and see if houses that are located at the river show a similar distribution:
lethousesAtRiver=dataAsFrame|>Frame.sliceCols["RoomsPerDwelling";"MedianHomeValue";"CharlesRiver"]|>Frame.filterRowValues(funs->s.GetAs<bool>("CharlesRiver"))letpricesAtRiver:seq<float>=housesAtRiver|>Frame.getCol"MedianHomeValue"|>Series.valuesleth2=[Chart.Histogram(pricesNotAtRiver)|>Chart.withTraceName"not at river"Chart.Histogram(pricesAtRiver)|>Chart.withTraceName"at river"]|>Chart.Combine|>Chart.withX_AxisStyle("median value of owner occupied homes in 1000s")|>Chart.withX_AxisStyle("Comparison of price distributions")
The interactive chart allows us to compare the distributions directly. We can now reconstruct our own idea of the city of boston, the sampled area, just by looking at the data e.g.:
Assuming that the sampling process was homogenous while observing that there are much more houses sampled that are not located on the riverside could indicate that a spot on the river is a scarce commodity.
This could also be backed by analyzing the tails of the distribution: it seems that houses located at the river are given a head-start in their assigned value - the distribution of the riverside houses is truncated on the left.
Suppose we would have a customer that wants two models, one to predict the prices of a house at the riverside and one that predicts the prices if this is not the case, then we can meet this demand by using FSharp.Stats in combination with Deedle. Of course we need a variable that is indicative of the house price, in this we will check if the number of rooms per dwelling correlates with the house value:
So indeed, the number of rooms per dwelling shows a positiv correlation with the house prices. With a pearson correlation of ~0.7 it does not explain the house prices completely - but this is nothing that really surprises us, as one of our hypothesis is that the location (e.g. riverside) does also have influence on the price - however, it should be sufficient to create a linear model.
So now we will use FSharp.Stats to build the two linear models ordered by the hypothetical customer. We start by defining a function that performs the fitting and plots the result:
openFitting.LinearRegression.OrdinaryLeastSquaresletpredictPricesByRoomsdescriptiondata=letpricesAll:Series<_,float>=data|>Frame.getCol"MedianHomeValue"letroomsPerDwellingAll:Series<_,float>=data|>Frame.getCol"RoomsPerDwelling"letfit=lettmpRooms,tmpPrices=Series.zipInnerroomsPerDwellingAllpricesAll|>Series.sortByfst|>Series.values|>Seq.unzipletcoeffs=Linear.Univariable.coefficient(vectortmpRooms)(vectortmpPrices)letmodel=Linear.Univariable.fitcoeffsletpredictedPrices=tmpRooms|>Seq.mapmodel[Chart.Point(tmpRooms,tmpPrices)|>Chart.withTraceName(sprintf"%s: data"description)Chart.Line(tmpRooms,predictedPrices)|>Chart.withTraceName(sprintf"%s: coefficients: intercept:%f, slope:%f"descriptioncoeffs.[0]coeffs.[1])]|>Chart.Combine|>Chart.withX_AxisStyle("rooms per dwelling")|>Chart.withY_AxisStyle("median value")fit
Afterwards, we can apply the function on our prepared datasets and have a look at the model and especially the model coefficients.
letmodelVis=[predictPricesByRooms"not at river"housesNotAtRiverpredictPricesByRooms"at river"housesAtRiver]|>Chart.Combine|>Chart.withSize(1200.,700.)
Both models approximate the data in a reasonable way. When we inspect the coefficients, we see that the models only differ slightly in slope, but have an absolute offset of ~7.5. This observation complements the insights gained by the explorative data analysis approach using the histogram!
Multiple items type MemoryStream = inherit Stream new : unit -> unit + 6 overloads member BeginRead : buffer: byte [] * offset: int * count: int * callback: AsyncCallback * state: obj -> IAsyncResult member BeginWrite : buffer: byte [] * offset: int * count: int * callback: AsyncCallback * state: obj -> IAsyncResult member CopyTo : destination: Stream * bufferSize: int -> unit member CopyToAsync : destination: Stream * bufferSize: int * cancellationToken: CancellationToken -> Task member Dispose : disposing: bool -> unit member EndRead : asyncResult: IAsyncResult -> int member EndWrite : asyncResult: IAsyncResult -> unit member Flush : unit -> unit ...
type Encoding = interface ICloneable new : unit -> unit + 2 overloads member Clone : unit -> obj member Equals : value: obj -> bool member GetByteCount : chars: nativeptr<char> * count: int -> int + 5 overloads member GetBytes : chars: nativeptr<char> * charCount: int * bytes: nativeptr<byte> * byteCount: int -> int + 7 overloads member GetCharCount : bytes: nativeptr<byte> * count: int -> int + 3 overloads member GetChars : bytes: nativeptr<byte> * byteCount: int * chars: nativeptr<char> * charCount: int -> int + 4 overloads member GetDecoder : unit -> Decoder member GetEncoder : unit -> Encoder ...
property System.Text.Encoding.UTF8: System.Text.Encoding with get
static member FrameExtensions.Print : frame:Frame<'K,'V> -> unit (requires equality and equality) static member FrameExtensions.Print : frame:Frame<'K,'V> * printTypes:bool -> unit (requires equality and equality)
val housesNotAtRiver : Frame<int,string>
val sliceCols : columns:seq<'C> -> frame:Frame<'R,'C> -> Frame<'R,'C> (requires equality and equality)
val filterRowValues : f:(ObjectSeries<'C> -> bool) -> frame:Frame<'R,'C> -> Frame<'R,'C> (requires equality and equality)
val s : ObjectSeries<string>
member ObjectSeries.GetAs : column:'K -> 'R member ObjectSeries.GetAs : column:'K * fallback:'R -> 'R
[<Struct>] type bool = System.Boolean
val not : value:bool -> bool
namespace Plotly
namespace Plotly.NET
val pricesNotAtRiver : seq<float>
Multiple items val seq : sequence:seq<'T> -> seq<'T>
-------------------- type seq<'T> = System.Collections.Generic.IEnumerable<'T>
Multiple items val float : value:'T -> float (requires member op_Explicit)
-------------------- [<Struct>] type float = System.Double
-------------------- type float<'Measure> = float
Multiple items module Frame
from Deedle
-------------------- type Frame = inherit DynamicObj new : unit -> Frame
-------------------- type Frame<'TRowKey,'TColumnKey (requires equality and equality)> = interface IDynamicMetaObjectProvider interface INotifyCollectionChanged interface IFsiFormattable interface IFrame new : rowIndex:IIndex<'TRowKey> * columnIndex:IIndex<'TColumnKey> * data:IVector<IVector> * indexBuilder:IIndexBuilder * vectorBuilder:IVectorBuilder -> Frame<'TRowKey,'TColumnKey> + 1 overload member AddColumn : column:'TColumnKey * series:seq<'V> -> unit + 3 overloads member AggregateRowsBy : groupBy:seq<'TColumnKey> * aggBy:seq<'TColumnKey> * aggFunc:Func<Series<'TRowKey,'a>,'b> -> Frame<int,'TColumnKey> member Clone : unit -> Frame<'TRowKey,'TColumnKey> member ColumnApply : f:Func<Series<'TRowKey,'T>,ISeries<'TRowKey>> -> Frame<'TRowKey,'TColumnKey> + 1 overload member DropColumn : column:'TColumnKey -> unit ...
